Skip to main content
Post Reopened by Christophe, Greg Burghardt, DannyNiu
added 284 characters in body
Added to review
Source Link
DannyNiu
  • 374
  • 1
  • 19

Semantic versioning is a scheme of versioning that make the compatibility of different versions of a software component apparent to human and non-human agents.

In essence, when a backwards-compatible change is made (e.g. addition of features), minor version increases; bugfix results in patch version increase; and breaking change increases major version.

A semantic version of a software is bound to its API specification in order to maintain compatibility. But what if the software is correct while the (human-facing documentation) specification is in error? Does correcting a non-trivial error in the doc increase patch, minor, or major version?

Update

Per comment by @GregBurghardt, where the document is hosted is irrelevant for this Q, but it comes with the software distribution, and correspond to the version that it document, most importantly it defines the API (or ABI in some cases) of the software component.

Semantic versioning is a scheme of versioning that make the compatibility of different versions of a software component apparent to human and non-human agents.

In essence, when a backwards-compatible change is made (e.g. addition of features), minor version increases; bugfix results in patch version increase; and breaking change increases major version.

A semantic version of a software is bound to its API specification in order to maintain compatibility. But what if the software is correct while the (human-facing documentation) specification is in error? Does correcting a non-trivial error in the doc increase patch, minor, or major version?

Semantic versioning is a scheme of versioning that make the compatibility of different versions of a software component apparent to human and non-human agents.

In essence, when a backwards-compatible change is made (e.g. addition of features), minor version increases; bugfix results in patch version increase; and breaking change increases major version.

A semantic version of a software is bound to its API specification in order to maintain compatibility. But what if the software is correct while the (human-facing documentation) specification is in error? Does correcting a non-trivial error in the doc increase patch, minor, or major version?

Update

Per comment by @GregBurghardt, where the document is hosted is irrelevant for this Q, but it comes with the software distribution, and correspond to the version that it document, most importantly it defines the API (or ABI in some cases) of the software component.

Post Closed as "Needs more focus" by gnat, Greg Burghardt, DavidT
Source Link
DannyNiu
  • 374
  • 1
  • 19

Correcting document errors in semantic versioning

Semantic versioning is a scheme of versioning that make the compatibility of different versions of a software component apparent to human and non-human agents.

In essence, when a backwards-compatible change is made (e.g. addition of features), minor version increases; bugfix results in patch version increase; and breaking change increases major version.

A semantic version of a software is bound to its API specification in order to maintain compatibility. But what if the software is correct while the (human-facing documentation) specification is in error? Does correcting a non-trivial error in the doc increase patch, minor, or major version?