Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor: "cargo doc" - Fixed lint issues with ContourBuilder. #19

Merged
merged 1 commit into from
May 10, 2024

Conversation

martinfrances107
Copy link
Contributor

I love this crate.... it is really useful.

I was reading the docs and notice a tiny blemish

running

cargo doc

Showed that the flaw was repeated 3 times, thankfully the fix is just a minor nudge.

In temrs of "self" review .. I can state that I have visually checked the doc after the change
and the fix works.

warning: unresolved link to `ContourBuilder`
 --> src/line.rs:4:73
  |
4 | /// A line has the geometry and threshold of a contour ring, built by [`ContourBuilder`].
  |                                                                         ^^^^^^^^^^^^^^ no item named `ContourBuilder` in scope
  |
  = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`

warning: `contour` (lib doc) generated 3 warnings

@mthh
Copy link
Owner

mthh commented May 10, 2024

Thank you!

@mthh mthh merged commit 6b3f9a9 into mthh:master May 10, 2024
4 checks passed
@martinfrances107 martinfrances107 deleted the doc_ContourBuilder branch May 11, 2024 07:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants