-
Swagger and TypeSpec both have all description string written in Markdown. In Pythonn, docstring are expected to be written in RST. In order to get our doc processor to generate valid documentation, i…
-
First of some local extensions needs "." in `sys.path
This can be fixed by patch like below:
```patch
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -15,8 +15,8 @@
import sphinx_rtd_theme
-sys.p…
-
**What should the feature do?**
Hi, I was wondering if you've ever considered [doxygen style comments](https://www.doxygen.nl/manual/docblocks.html) to your C function declarations? Preferably this s…
-
-
2024-06-07 12:41:18.389 [info] [Error - 12:41:18 PM] ChatGPT: Docstring Generator client: couldn't create connection to server.
2024-06-07 12:41:18.389 [info] Error: command 'chatgpt-docstrings.apply…
-
**Describe the bug**
I have used `datamodel-code-generator` with a custom mapping to create a Pydantic v2 model. Doing that resulted in [field names having the same name as other models](https://gith…
-
In 43eea5b41d84ab70fb3c71e1d7d77aa11ff1cf18, I added a template filter with a docstring that was rendered as [reStructuredText](http://sphinx-doc.org/rest.html) in [admindocs](https://docs.djangoproje…
-
While not official, many documentation generators, e.g. Sphinx, pdoc, epydoc, PyCharm, etc., recognize docstrings after variables.
flake8-quotes however classifies these as multi-line strings, so w…
-
Hi 👋
The following throws a
```
164: DOC405: Function `yields` has both "return" and "yield" statements. Please use Generator[YieldType, SendType, ReturnType] as the return type annotation, and …
-
### Bug description
Per #4698:
> The most efficient way to create a empty generator is to add yield after return. pylint should not add the warning unreachable code for it. https://stackoverflow…