From 020ef212c1ab549a956fd558377b4dbfd40bb62b Mon Sep 17 00:00:00 2001 From: ofir-frd Date: Sat, 22 Feb 2025 16:46:31 +0200 Subject: [PATCH] docs: fix notes admonition syntax in documentation --- docs/docs/tools/documentation.md | 2 +- docs/docs/tools/test.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/tools/documentation.md b/docs/docs/tools/documentation.md index 1c1e328d..b09eda3e 100644 --- a/docs/docs/tools/documentation.md +++ b/docs/docs/tools/documentation.md @@ -27,6 +27,6 @@ You can state a name of a specific component in the PR to get documentation only - `docs_style`: The exact style of the documentation (for python docstring). you can choose between: `google`, `numpy`, `sphinx`, `restructuredtext`, `plain`. Default is `sphinx`. - `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...". -!!! notes "Notes" +!!! note "Notes" - The following languages are currently supported: Python, Java, C++, JavaScript, TypeScript, C#. - This tool can also be triggered interactively by using the [`analyze`](./analyze.md) tool. diff --git a/docs/docs/tools/test.md b/docs/docs/tools/test.md index 2d5652ae..0d3da4ff 100644 --- a/docs/docs/tools/test.md +++ b/docs/docs/tools/test.md @@ -17,7 +17,7 @@ The tool will generate tests for the selected component (if no component is stat (Example taken from [here](https://github.com/Codium-ai/pr-agent/pull/598#issuecomment-1913679429)): -!!! notes "Notes" +!!! note "Notes" - The following languages are currently supported: Python, Java, C++, JavaScript, TypeScript, C#. - This tool can also be triggered interactively by using the [`analyze`](./analyze.md) tool.