Skip to content

Clarify supported version syntax in README#1068

Merged
smorimoto merged 1 commit intomasterfrom
clarify-version-syntax-docs
Mar 20, 2026
Merged

Clarify supported version syntax in README#1068
smorimoto merged 1 commit intomasterfrom
clarify-version-syntax-docs

Conversation

@smorimoto
Copy link
Copy Markdown
Member

@smorimoto smorimoto commented Mar 20, 2026

Summary

  • Document that the highest matching version from opam-repository is always selected when a version range is used
  • Add a WARNING admonition about YAML float parsing (e.g. unquoted 5.10 is silently parsed as 5.1)
  • Quote version strings in the examples section to reinforce the recommended practice

Closes #954

Test plan

  • Verify the WARNING and NOTE admonitions render correctly on GitHub
  • Confirm the inline YAML code block inside the WARNING renders properly

Add a YAML float-parsing warning (e.g. unquoted 5.10 becomes 5.1),
document that the highest matching version is always selected, and
quote version strings in the examples section.

Closes #954
@smorimoto smorimoto added the documentation Improvements or additions to documentation label Mar 20, 2026
@smorimoto smorimoto merged commit d66b9d1 into master Mar 20, 2026
18 checks passed
@smorimoto smorimoto deleted the clarify-version-syntax-docs branch March 20, 2026 11:12
@smorimoto smorimoto mentioned this pull request Mar 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make the Supported version syntax section of README.md more precise?

1 participant