Centralize text common to code and documentation (e.g., required python version numbers)
Open
@rountree is already working on this.
Since May 8, 2024.
docs
feature
- Dominant language
- Python
- Stars
- 78
- Forks
- 52
- Avg merge
- 4d 19m
- Merged PRs (30d)
- 10
Description
We'd like to have the benchpark binary be able to check the version of python in use against the minimum version, mention the minimum version in the documentation, and both tied to a common source so there's only a single file that needs to get updated.
rst has a ``.. literalinclude::`` tag that should fit the bill. Perhaps have a file ``ground_truth/min_python_version.txt`` that is included via ``literalinclude`` in the docs and (with a bit more work) parsed by python in the benchpark script.
This avoids any CI silliness.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.