Skip to content

Conversation

tomschr
Copy link
Member

@tomschr tomschr commented Apr 18, 2020

This PR is not based on a specific issue.

As we had deprecated module-level functions now, we shouldn't advertise it in our documentation too much.

Module level functions like semver.bump_version are still available in the documentation, but they play a much less important role now. The preferred way is to use semver.Versioninfo instances to use.

@python-semver/reviewers I guess it's easy to review and contains only doc changes. 😉 If noone objects, I will merge it on Monday.

@tomschr tomschr added Doc Documentation related issue Enhancement Not a bug, but increases or improves in value, quality, desirability, or attractiveness labels Apr 18, 2020
@tomschr tomschr self-assigned this Apr 18, 2020
@tomschr tomschr force-pushed the feature/doc-focus-on-versioninfo branch 2 times, most recently from fa379a9 to f925cd1 Compare April 18, 2020 10:41
@tomschr tomschr mentioned this pull request Apr 18, 2020
5 tasks
@tomschr tomschr force-pushed the feature/doc-focus-on-versioninfo branch from f925cd1 to 6ddd6d7 Compare April 19, 2020 08:18
tomschr added a commit to tomschr/python-semver that referenced this pull request Apr 19, 2020
* Module level functions like `semver.bump_version` are still available
  in the documentation, but they play a much less important role now.
  The preferred way is to use semver.Versioninfo instances to use.

* Replace 2.9.2 -> 2.10.0 due to python-semver#237
@tomschr tomschr force-pushed the feature/doc-focus-on-versioninfo branch from 6ddd6d7 to 0720a53 Compare April 19, 2020 08:24
tomschr added a commit to tomschr/python-semver that referenced this pull request Apr 19, 2020
* Module level functions like `semver.bump_version` are still available
  in the documentation, but they play a much less important role now.
  The preferred way is to use semver.Versioninfo instances to use.

* Replace 2.9.2 -> 2.10.0 due to python-semver#237

* Fix docstring examples
@tomschr tomschr force-pushed the feature/doc-focus-on-versioninfo branch from 0720a53 to 7bfbf1d Compare April 19, 2020 10:07
* Module level functions like `semver.bump_version` are still available
  in the documentation, but they play a much less important role now.
  The preferred way is to use semver.Versioninfo instances to use.

* Replace 2.9.2 -> 2.10.0 due to python-semver#237

* Fix docstring examples
@tomschr tomschr force-pushed the feature/doc-focus-on-versioninfo branch from 7bfbf1d to b145931 Compare April 19, 2020 10:23
@tomschr tomschr merged commit 9691b41 into python-semver:master Apr 20, 2020
@tomschr tomschr deleted the feature/doc-focus-on-versioninfo branch April 20, 2020 05:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Doc Documentation related issue Enhancement Not a bug, but increases or improves in value, quality, desirability, or attractiveness
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant