-
Notifications
You must be signed in to change notification settings - Fork 127
Update docs around version discovery #602
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
Changes from 3 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -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): | ||||||||||
|
||||||||||
| ``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: |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 2. Set a ``version`` key in your configuration file. | |
| 2. Set a value for the ``version`` option in your configuration file. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Clarify version discovery behavior. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Clarify version discovery behavior. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.