This PR clarifies the supported and intended syntax of the #VERSION header.
Following the discussion in #13 this PR clarifies that valid values of the version header look like 1.2.3 and are intended to be have similarly to SermVer. However not all of the SemVer syntax is being used (e.g. prereleases).
Closes Issue(s)
Relates to #13.
Motivation
I feel like stating that the #VERSION header can be any valid SemVer is misleading if there is no intent of making use of prereleases or metadata. Having the syntax stated more clearly avoids misunderstandings and simplifies implementations.
What does this PR do?
This PR clarifies the supported and intended syntax of the
#VERSIONheader. Following the discussion in #13 this PR clarifies that valid values of the version header look like1.2.3and are intended to be have similarly to SermVer. However not all of the SemVer syntax is being used (e.g. prereleases).Closes Issue(s)
Relates to #13.
Motivation
I feel like stating that the
#VERSIONheader can be any valid SemVer is misleading if there is no intent of making use of prereleases or metadata. Having the syntax stated more clearly avoids misunderstandings and simplifies implementations.