Skip to content

Conversation

blueyed
Copy link
Collaborator

@blueyed blueyed commented May 28, 2019

This fixes some wording, but more important adjusts the examples to what actually happens.

Not sure about if e.g. .dirty with versioning=post should be used really instead of +g1, but I've actually tried it.. ;)

I've left some "XXX" remarks - please comment / reply inline on the diff.

* It can be a drop-in replacement for setuptools_scm_

# XXX: also "dev" and "devcommit"?!
# XXX: the code also handles "changes" (https://github.com/zsimic/setupmeta/blob/586102493f7167d47d633ff46eb9945ae36b730c/setupmeta/versioning.py#L305)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

devcommit is described at bottom of page (very similar to dev, so I didn't put a section for it, maybe we should :) )
changes was the old name for distance, wasn't sure anyone ever used it, so left it there just in case.

# XXX: also "dev" and "devcommit"?!
# XXX: the code also handles "changes" (https://github.com/zsimic/setupmeta/blob/586102493f7167d47d633ff46eb9945ae36b730c/setupmeta/versioning.py#L305)
# XXX: ...and "default", and "tag"
# XXX: s/strategies/formats/ ? (otherwise vice-versa below in the heading)
Copy link
Collaborator

@zsimic zsimic May 28, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yes, looks like I missed default and tag (which are the same as post)... should maybe remove those 2?

Regarding strategies, I picked that name because it was less common than format, and thought it conveyed the fact that there's a choice about how the version will evolve (e.g. you get different outcomes with post vs dev).

@zsimic
Copy link
Collaborator

zsimic commented May 28, 2019

Thank you! Looks like I forgot to update that indeed, and there quite a few weird phrasings I didn't even realize were there :)

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

Successfully merging this pull request may close these issues.

2 participants