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

Docs build error (google vs numpy docstrings) #3841

Closed
tkknight opened this issue Sep 11, 2020 · 0 comments · Fixed by #3871
Closed

Docs build error (google vs numpy docstrings) #3841

tkknight opened this issue Sep 11, 2020 · 0 comments · Fixed by #3871

Comments

@tkknight
Copy link
Contributor

📚 Documentation

The "make linkcheck" on master as of 11/09/20 shows an odd error on travis, see https://travis-ci.org/github/SciTools/iris/jobs/725551522#L1237.

Build issue shows as:

Reading sources... [100%] whatsnew/latest
/home/travis/miniconda/envs/iris-dev/lib/python3.7/site-packages/scitools_iris-3.0.dev0-py3.7.egg/iris/palette.py:docstring of iris.palette.SymmetricNormalize.process_value:6: WARNING: Unexpected section title.
Returns
-------
/home/travis/miniconda/envs/iris-dev/lib/python3.7/site-packages/scitools_iris-3.0.dev0-py3.7.egg/iris/palette.py:docstring of iris.palette.SymmetricNormalize.process_value:13: WARNING: Unexpected section title.
Notes
-----
looking for now-outdated files... none found

I believe this is due to the Iris code base using Google Style docstrings but the code that is pulled in above is from matplotlib that now uses NumPy docstrings, see https://matplotlib.org/_modules/matplotlib/colors.html#Normalize.process_value.

#3840 may resolve this.

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

Successfully merging a pull request may close this issue.

2 participants