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

DOC: Show module docstring #2354

Merged
merged 2 commits into from
Apr 3, 2024
Merged

DOC: Show module docstring #2354

merged 2 commits into from
Apr 3, 2024

Conversation

lgolston
Copy link
Contributor

Rationale

A remaining issue with the latest docs, comparing against https://scitools.org.uk/cartopy/docs/v0.17/, is that the module level docstring is not currently showing but can contain very useful information.

Implications

This is fixed simply using automodule instead of module. However, in some cases documentation has been added to the rst file directly, which I have either transferred to the corresponding module/class, or combined if there was already a docstring, which should be better for maintainability of the information. I have have also tried to reduce repetition of 'this module... ' in several places for readability purposes.

@lgolston
Copy link
Contributor Author

Thanks for approving @dopplershift. Just wanted to make two small changes, which are added now:

  • Combined text in one more place in cartopy.io I had missed.
  • Added a link in Feature to FeatureArtist with regard to where zorder of 1.5 is defined, since that doc was slightly confusing.

@greglucas greglucas merged commit 6cc3781 into SciTools:main Apr 3, 2024
23 checks passed
@QuLogic QuLogic added this to the Next Release milestone Apr 3, 2024
@lgolston lgolston deleted the module-docs branch April 4, 2024 02:45
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

Successfully merging this pull request may close these issues.

4 participants