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

Wrong documentation for version command #1787

Closed
slawiko opened this issue Nov 18, 2018 · 2 comments
Closed

Wrong documentation for version command #1787

slawiko opened this issue Nov 18, 2018 · 2 comments

Comments

@slawiko
Copy link

slawiko commented Nov 18, 2018

Current Behavior

As I see from code produced commit message will consist in message + tags info. But in documentation I see %s and %v placeholders which, according to examples, must remove tags info.

Don't know if it's a bug, or documentation mismatch (that's the reason why I didn't prepare PR). Anyway it would be nice to have opportunity to override commit message.

I'm ready to help with fix, just mention the fix so that I can create PR

@evocateur
Copy link
Member

The current documentation includes this important clause:

Note that this only applies when using the default "fixed" versioning mode, as there is no "global" version when versioning independently.

"this" in this sentence refers to the placeholder interpolation. The linked method is only called when versioning independently.

@lock
Copy link

lock bot commented Mar 7, 2019

This thread has been automatically locked because there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@lock lock bot locked as resolved and limited conversation to collaborators Mar 7, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants