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

Docstring improvements for hidedecorations!, etc. #3363

Merged
merged 3 commits into from
Nov 16, 2023

Conversation

jwahlstrand
Copy link
Contributor

Description

Describe what the keyword arguments of hidedecorations!, hidexdecorations!, etc. do. Also fix a few other docstrings.

Fixes #2846

Type of change

Delete options that do not apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

  • Added an entry in NEWS.md (for new features and breaking changes)
  • Added or changed relevant sections in the documentation
  • Added unit tests for new algorithms, conversion methods, etc.
  • Added reference image tests for new plotting functions, recipes, visual options, etc.

Copy link
Member

@jkrumbiegel jkrumbiegel left a comment

Choose a reason for hiding this comment

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

In principle good, but I think we had problems with @ref links in docstrings because we don't use documenter. Maybe just remove the links from those mentions for now?

@jwahlstrand
Copy link
Contributor Author

Sounds good, I removed @ref.

@SimonDanisch SimonDanisch merged commit 6778cd1 into MakieOrg:master Nov 16, 2023
14 checks passed
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.

Can't turn of the grid of two axis simultaneously
3 participants