-
Notifications
You must be signed in to change notification settings - Fork 97
Closed
Description
Situation
Currently, the documentation in the "Usage" section is limited. It covers the important parts very briefly, but also lacks other features that are added recently, For example, iterating over a VersionInfo
or passing strings to VersionInfo
and others.
IMHO, the documentation is an integral and crucial part of helping our users to use the module successfully and efficiently.
Proposed Solution
The "Usage" section should cover, as an example, but not limited to:
- create instances of
VersionInfo
- access different parts of a version
- convert different types into each other (for example, a dict into
VersionInfo
and vice versa) - increase/bump parts of a version
- compare two versions
Metadata
Metadata
Assignees
Labels
No labels