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] Add Version Changed mark for new methods and arguments #1188

Open
Zeroto521 opened this issue Nov 2, 2022 · 2 comments
Open

[DOC] Add Version Changed mark for new methods and arguments #1188

Zeroto521 opened this issue Nov 2, 2022 · 2 comments

Comments

@Zeroto521
Copy link
Member

Add marks like note or summary to note users that these methods and arguments are newly added.
To avoid #1145.

sphinx has some marks

  • versionchanged
    image
  • versionadded
    image

mkdocs doesn't offer official marks.

@samukweku
Copy link
Collaborator

samukweku commented Nov 2, 2022

@Zeroto521 how do we agree on the version number? Do we have a script that verifies this? breaking change and patches have different version numbers

@Zeroto521
Copy link
Member Author

Zeroto521 commented Nov 2, 2022

breaking change and patches have different version numbers

My experience is that both conditions use the major.mirror+1.0 as the version number.
Version construction: major.mirror.patch.

Such as the current pyjanitor version: 0.23.1. So use 0.24.0 to notify users that new features will come at that version.
Because we can't pre-know how many patch versions there will have.

__version__ = "0.23.1"

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

2 participants