Skip to content

DOC More explanations in the readme needed #64

@rth

Description

@rth

Thanks for this package!

Just wanted to report that it was not very clear under what key section should https://github.com/ofek/hatch-vcs#version-source-options go. Tried to put them under,

[tool.hatch.version.raw-options]

with no luck.

I'll probably will figure it out after more searching, but the documentation of that section could use improvement.

Similarly it wouldn't hurt for the readme to be more self contained. If I compare it to pypa/setuptools_scm the readme just says do these few toml lines and it would work.

In the current readme, I see

The [version source plugin](https://hatch.pypa.io/latest/plugins/version-source/reference/) name is vcs.

as a user it's not clear whether I need to enable this or not. Probably yes, OK. Next there is "Version source options" as mentioned above, no idea how to use this.

Then is Build hook . I have to click on an external link to get a definition of what it is,

A build hook provides code that will be executed at various stages of the build process. See the documentation for build hook configuration.

it still doesn't really tell me what it does in the context of this plugin and whether I need it.

As a longtime dev coming from setuptools it's a bit confusing, in case you wanted feedback. I'll try to make a PR to improve the readme )

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions