Skip to content

Conversation

@maxrjones
Copy link
Member

Description of proposed changes

This PR adds a deprecations section to the ReST docs for modules that will have deprecations in 6.3

Fixes #5615

Reminders

  • Make sure that your code follows our style. Use the other functions/files as a basis.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Describe changes to function behavior and arguments in a comment below the function declaration.
  • If adding new functionality, add a detailed description to the documentation and/or an example.

@maxrjones maxrjones requested a review from seisman October 6, 2021 17:36
@maxrjones maxrjones added add-changelog Add PR to the changelog documentation Improve documentation labels Oct 6, 2021
Copy link
Member

@PaulWessel PaulWessel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great!

@maxrjones maxrjones merged commit 192b118 into master Oct 6, 2021
@maxrjones maxrjones deleted the docs-deprecations branch October 6, 2021 19:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

add-changelog Add PR to the changelog documentation Improve documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document option changes in the HTML documentation

3 participants