electric-coder

Results 36 comments of electric-coder

> Describe alternatives you've considered I don't know about the alternative that jayadission proposed, but to keep things simple I use a [glossary](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-glossary) for the kind of use case you...

> Naming this seems like a bit of a challenge, maybe cpp:ns or similar I'm not a C++ expert but there's a precedent for names clashing between reStructuredText and CSS...

@picnixz > Oh good to know. @AA-Turner any reason why we are not applying mypy to tests actually? Most likely because it can be a lot of extra work and...

@provinzkraut the links can be made to work (in the cases where autodoc doesn't resolve them automatically) by coding them explicitly into the `.rst` files or the type fields of...

Another case that hasn't been mentioned: When you use `from __future__` with a quoted class that's defined in the same module (e.g. you type hint the class above and it's...

@picnixz this is likely the one issue that's affecting most docs in the wild at the moment, together with some types not linking properly (like `None`, `Yield` and `Literal`). I...

As I explained [here](https://github.com/sphinx-doc/sphinx/issues/11999#issuecomment-1961335082) your Markdown has syntax errors.

@weibullguy I think this issue can be closed. Using the `--blank = false` option from the [Current Implementation](https://docformatter.readthedocs.io/en/latest/requirements.html#current-implementation) in version 1.7.1 does currently remove the empty blank line from the...

> Running with nitpicky mode shows: > > module.py:docstring of module.read_file:1: WARNING: py:class reference target not found: pathlike I was looking for a Python 3.9 workaround (not using `TypeVar`) if...

I'm also running into these using Firefox: > The resource at “file:///C:/my_project/docs/build/html/_static/vendor/fontawesome/6.5.1/webfonts/fa-solid-900.woff2” preloaded with link preload was not used within a few seconds. Make sure all attributes of the preload...