Replies: 3 comments
-
|
Documentation improvements are welcome, but I don't think a broad issue is
useful (since it's an ongoing process). Also, a massive PR is not ideal. I
think smaller chunks is going to be a better path. For example, there could
be a PR which improves TextInfo documentation.
|
Beta Was this translation helpful? Give feedback.
-
|
I would advise against removing code as part of a bigger issue. It is more likely to hide mistakes, and make it harder to consider whether it truly is safe to remove. Since its unlikely this will get done internally, I'll set this as priority 4. Happy to accept a PR for these changes. |
Beta Was this translation helpful? Give feedback.
-
|
Hi, 2024 update: source code docs situation is getting better. In particular, asking developers to add docs as part of pull requests (when introducing new functions/classes) is giving us improved documentation (ultimately to be generated by Sphinx). We might as well convert this into a discussion. Thanks. |
Beta Was this translation helpful? Give feedback.
-
Hi,
Continuing from #6589:
In addition to code cleanup, I'd like to propose that we do something about source code docs (function docstrings, ePyDoc issues, etc.). Specifically:
Thanks.
Beta Was this translation helpful? Give feedback.
All reactions