skoji / skoji/shellac

Documentation polish: coordinate guidance, module overview, minor doc warnings

Open
#9 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
0
Forks
0
Avg merge
1d 7h
Merged PRs (30d)
2

Description

Small documentation fixes, grouped so they can land as one PR.

Coordinate guidance (crate README)

  • The Coordinates paragraph explains when rect needs shellac::transform::rect_page_space_to_user, but the same guidance applies to quad_points and user_point when they originate from a display frame. Say so, so all three fields are covered.
  • The module overview (crate README, "what's public" paragraph) lists ops and transform but not annots. The top-level README already lists all three; align the crate README, since that is the copy rendered on crates.io.

rustdoc warnings

  • annots.rs:5 has a bare URL (rustdoc::bare_urls, the only remaining cargo doc warning). Wrap it in <...>.

Comment wording

  • report.rs: the C8 legend string hardcodes 10 for the loop iteration count (the value is pinned by a rendering test, so this is cosmetic; either derive it or leave a pointer to the constant).
  • transform.rs:34,36,142,216: "still useful" / "remain" / "kept" / "remains" — tense words that imply a history the reader cannot see. Restate as present facts.
  • min_max_x / min_max_y comments justify avoiding iterator chains via the Option return of min_by / max_by; the claim is broader than the cited reason. Narrow the wording.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the crate README and compare its module overview with the top-level README, then inspect annots.rs, report.rs, and the cited locations in transform.rs. Run cargo doc to confirm the bare-URL warning is gone and run the existing rendering tests. Done means the coordinate guidance, module list, comments, and C8 legend wording are updated without changing behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.