Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lots of UserWarnings for Unknown Section despite GL06 rule exemption #589

Open
Zeitsperre opened this issue Nov 8, 2024 · 0 comments
Open

Comments

@Zeitsperre
Copy link

Hi there,

I'm wondering what the best way forward is for my use case. I currently make use of the module-level docstrings to supply the documentation on my project's ReadTheDocs page. This can include adding sections that are not in the standard.

Ignoring GL06/Unknown Section should be enough to handle this, but I still end up with many UserWarning messages when running the tool, e.g.

/pc/clone/_SwdT2XXRaOD_6gJ7rZXAA/py_env-python3/lib/python3.12/site-packages/numpydoc/docscrape.py:421: UserWarning: Unknown section Calendar Handling Utilities
  self[section] = content
/pc/clone/_SwdT2XXRaOD_6gJ7rZXAA/py_env-python3/lib/python3.12/site-packages/numpydoc/docscrape.py:421: UserWarning: Unknown section Cf-convention Checking
  self[section] = content
/pc/clone/_SwdT2XXRaOD_6gJ7rZXAA/py_env-python3/lib/python3.12/site-packages/numpydoc/docscrape.py:421: UserWarning: Unknown section Data Checks
  self[section] = content
/pc/clone/_SwdT2XXRaOD_6gJ7rZXAA/py_env-python3/lib/python3.12/site-packages/numpydoc/docscrape.py:421: UserWarning: Unknown section Data Flags
  self[section] = content
/pc/clone/_SwdT2XXRaOD_6gJ7rZXAA/py_env-python3/lib/python3.12/site-packages/numpydoc/docscrape.py:421: UserWarning: Unknown section Formatting Utilities For Indicators
  self[section] = content
/pc/clone/_SwdT2XXRaOD_6gJ7rZXAA/py_env-python3/lib/python3.12/site-packages/numpydoc/docscrape.py:421: UserWarning: Unknown section Indicator Utilities
  self[section] = content
/pc/clone/_SwdT2XXRaOD_6gJ7rZXAA/py_env-python3/lib/python3.12/site-packages/numpydoc/docscrape.py:421: UserWarning: Unknown section Dictionary And Yaml Parser
  self[section] = content
...

It would be great if ignoring GL06 would also prevent these UserWarnings from being emitted.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant