Revise user guide for clarity and accuracy - #378
Closed
nikjascrazzy wants to merge 2 commits into
Closed
Conversation
Contributor
|
The repo should define Graphviz for its ci/cd as a hook. Here's an example: https://github.com/markrichardson/dummyrepo/blob/main/local-setup.sh A user of the package should define Graphviz as instructed on the page: https://graphviz.org/download/ |
Collaborator
|
Thanks for this — the Graphviz rewrite here is correct on two things the page had wrong for a long time: that Loman shells out to Your sections have been carried into #426, which modernises the whole page — uv, the supported Python versions, and a development-install section covering Rhiza — with you credited as co-author on the commit. Two things worth saying plainly:
Closing as incorporated. The content is in #426, not discarded. |
HarryCampion
added a commit
that referenced
this pull request
Sep 7, 2026
The page still recommended Anaconda as the way to install Loman, and told readers to run `python install graphviz` -- not a command -- to get a Python library Loman does not use. It made no mention of uv, of the Python versions Loman actually supports, or of how to set the project up to work on. Rewritten around what is true now: - **Requirements.** Python 3.11+, tested on 3.11 through 3.14. The page never said. - **uv first**, with `uv add`, `uv pip install` and `uv run --with loman` for a throwaway environment; pip kept alongside it, conda covered honestly (Loman is on PyPI and not conda-forge, so inside a conda env the answer is still pip). - **Graphviz.** Loman shells out to `dot`; the Python glue is `pydotplus` and it arrives with Loman. The old text named the `graphviz` PyPI package, which is not a dependency, and gave Anaconda-era Windows paths. Now a per-platform table, a `dot -V` check, and Windows PATH guidance that matches where current installers put the binary. - **Development.** New section: clone, `make install`, and the fact that the environment comes from Rhiza -- the Makefile is a shim forwarding to rhiza-task, fetched through uvx, and `make install` also runs local-setup.sh, which installs Graphviz so the visualization tests can run. The Graphviz sections are @nikjascrazzy's work from #378, resolved against the `## Optional extras` section that landed in #411 after that PR was opened, with conda-forge added as a row. #378 is superseded rather than rejected. Verified: tests/test_docs.py passes (7); the built page contains each command as rendered text; both relative links resolve; the build's single warning is the pre-existing one in release.md, untouched here. Checked rather than assumed: loman is absent from conda-forge (404) and present on PyPI, graphviz is on conda-forge, and `install` really does depend on `setup`. Co-authored-by: nikjascrazzy <nikjascrazzy@users.noreply.github.com> Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User guide updated to include cross-platform instructions on how to install and use Graphviz