Update docs around version discovery #602
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SmileyChris
changed the title
adiroiban
approved these changes
May 23, 2024
docs/tutorial.rst
Outdated
| @@ -51,13 +51,16 @@ The ``.gitignore`` will remain and keep Git from not tracking the directory. | |||
| Detecting Dates & Versions | |||
There was a problem hiding this comment.
Maybe it's best to have a separate section for version and date.
Most of the info from this section is about version.
A separate section should make it easier to jump to the information aboute date.
and I think that it only detects the current version, so not plural.
Suggested change
| Detecting Dates & Versions | |
| Detecting version |
docs/tutorial.rst
Outdated
| @@ -51,13 +51,16 @@ The ``.gitignore`` will remain and keep Git from not tracking the directory. | |||
| Detecting Dates & Versions | |||
| -------------------------- | |||
|
|
|||
| ``towncrier`` needs to know what version your project is, and there are two ways you can give it: | |||
| ``towncrier`` needs to know what version your project is. These are the ways you can provide it (and their order of precedence): | |||
There was a problem hiding this comment.
I think it's best to use Semantic newlines for documentation content.
Maybe also update this page
https://towncrier.readthedocs.io/en/latest/contributing.html
I guess that not every operaition needs the version.
I don't expect to requiere the version for a create command.
It's not 100% clear what's the order of precendece.
Suggested change
| ``towncrier`` needs to know what version your project is. These are the ways you can provide it (and their order of precedence): | |
| Most ``towncrier`` commands, like `build` or `check`, needs to know what version your project is. | |
| These are the ways you can provide it and their order of precedence. | |
| A lower precedence number will overwrite any other method with a higher number: |
docs/tutorial.rst
Outdated
| This can be either a string literal, a tuple, or an `Incremental <https://github.com/twisted/incremental>`_ version. | ||
| - Manually passing ``--version=<myversionhere>`` when interacting with ``towncrier``. | ||
| 1. Manually pass ``--version=<myversionhere>`` when interacting with ``towncrier``. | ||
| 2. Set a ``version`` key in your configuration file. |
There was a problem hiding this comment.
Suggested change
| 2. Set a ``version`` key in your configuration file. | |
| 2. Set a value for the ``version`` option in your configuration file. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The tutorial text should be updated to match the version discovery changes.
Checklist
src/towncrier/newsfragments/. Describe yourchange and include important information. Your change will be included in the public release notes.
docs/tutorial.rstis still up-to-date.