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.

Sign up for GitHub

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

Jump to bottom

docs: Improve docs for Point and Vec2 #363

Merged
merged 1 commit into from
Aug 16, 2024
Merged

docs: Improve docs for Point and Vec2 #363

merged 1 commit into from
Aug 16, 2024

Conversation

waywardmonkeys
Copy link
Contributor

This adds some cross-linking as well as a couple of additional doc tests.

DJMcNab
DJMcNab approved these changes Aug 5, 2024
View reviewed changes
Copy link
Member

@DJMcNab DJMcNab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to improve docs here.

I think that almost all of the links to items which are on the same page are quite noisy and don't provide much value, so would prefer them to be removed.
But I'm not going to block on that if you think it's better.

src/vec2.rs Show resolved Hide resolved
src/point.rs Outdated
Comment on lines 106 to 109
/// * [`Point::ceil`]
/// * [`Point::expand`]
/// * [`Point::floor`]
/// * [`Point::trunc`]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure these are that helpful; std doesn't have the equivalent links.

src/point.rs Outdated Show resolved Hide resolved
src/vec2.rs Show resolved Hide resolved
src/point.rs Outdated Show resolved Hide resolved
src/vec2.rs Outdated Show resolved Hide resolved
@waywardmonkeys waywardmonkeys added this to the August, 2024 Release milestone Aug 6, 2024
@DJMcNab DJMcNab mentioned this pull request Aug 12, 2024
Merged
@waywardmonkeys waywardmonkeys force-pushed the update-point-vec2-docs branch from be9f1a2 to 502830d Compare August 16, 2024 04:29
@waywardmonkeys
Copy link
Contributor Author

Updated, I think I've addressed the feedback.

I disagree about some of it, but I'll go with the flow for now!

@waywardmonkeys waywardmonkeys requested a review from DJMcNab August 16, 2024 04:31
DJMcNab
DJMcNab approved these changes Aug 16, 2024
View reviewed changes
Copy link
Member

@DJMcNab DJMcNab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great! This looks really good!

src/vec2.rs Outdated Show resolved Hide resolved
@waywardmonkeys
docs: Improve docs for Point and Vec2
a6b09fa 
This adds some cross-linking as well as a couple of additional
doc tests.
@waywardmonkeys waywardmonkeys force-pushed the update-point-vec2-docs branch from 502830d to a6b09fa Compare August 16, 2024 10:07
@waywardmonkeys waywardmonkeys added this pull request to the merge queue Aug 16, 2024
Merged via the queue into linebender:main with commit cac7f19 Aug 16, 2024
15 checks passed
@waywardmonkeys waywardmonkeys deleted the update-point-vec2-docs branch August 16, 2024 10:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DJMcNab DJMcNab DJMcNab approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
0.11.1
Development

Successfully merging this pull request may close these issues.
2 participants
@waywardmonkeys @DJMcNab