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

rustdoc: Fix some typos in components/layout_2020/table/mod.rs #31644

Merged
merged 1 commit into from Mar 19, 2024

Conversation

ektuu
Copy link
Contributor

@ektuu ektuu commented Mar 13, 2024


  • ./mach build -d does not report any errors
  • ./mach test-tidy does not report any errors
  • These changes do not require tests because they involve minor documentation adjustments that do not impact the functionality or output of the code.

Copy link
Member

@mrobinson mrobinson left a comment

Choose a reason for hiding this comment

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

This PR removes a lot of code and documentation unnecessarily. Is this the results of pasting the code into an AI model and then just pasting the results into the file? Please don't do that. At the very least, make sure the code changes compile locally. This is what we ask in the commit template and it's good practice contributing to open source projects.

#[derive(Clone, Debug, Serialize)]
pub struct TableTrack {
/// The [`BaseFragmentInfo`] of this cell.
/// The BaseFragmentInfo of this cell.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
/// The BaseFragmentInfo of this cell.
/// The BaseFragmentInfo of this cell.

Rather than removing the link, let's import the struct via a use statement. It should be public enough.

@@ -256,32 +83,26 @@ pub struct TableTrack {
/// groups.
group_index: Option<usize>,

/// Whether or not this [`TableTrack`] was anonymous, for instance created due to
/// Whether or not this TableTrack was anonymous, for instance created due to
Copy link
Member

Choose a reason for hiding this comment

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

This change is unnecessary and removes the link.

Comment on lines 95 to 105
/// The BaseFragmentInfo of this TableTrackGroup.
base_fragment_info: BaseFragmentInfo,

/// The style of this [`TableTrackGroup`].
/// The style of this TableTrackGroup.
#[serde(skip_serializing)]
style: Arc<ComputedValues>,

/// The type of this [`TableTrackGroup`].
/// The type of this TableTrackGroup.
group_type: TableTrackGroupType,

/// The range of tracks in this [`TableTrackGroup`].
/// The range of tracks in this TableTrackGroup.
Copy link
Member

Choose a reason for hiding this comment

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

Please don't remove these links.

@ektuu
Copy link
Contributor Author

ektuu commented Mar 13, 2024

@mrobinson I really apologize for this carelessness. I'm a bit new to open source, and forgot to read Contribution Guidelines.
This was due to co-pilot in my VS Code.
I'll fix this by tomorrow, and make sure to not repeat such stupid mistakes again.

@ektuu ektuu marked this pull request as draft March 14, 2024 00:30
@mrobinson
Copy link
Member

@mrobinson I really apologize for this carelessness. I'm a bit new to open source, and forgot to read Contribution Guidelines. This was due to co-pilot in my VS Code. I'll fix this by tomorrow, and make sure to not repeat such stupid mistakes again.

No worries. It's okay to use tools to help your work, but please make sure that things are working before opening a pull request. Welcome to the Servo project. If you haven't already, I recommend joining our Zulip chat and introducing yourself.

@mrobinson
Copy link
Member

@ektuu Are you planning on continuing to work on this change?

@mrobinson mrobinson force-pushed the fix-doc-link-to-private-item branch from 18c1da2 to 1a9abc5 Compare March 19, 2024 07:53
@mrobinson mrobinson changed the title Fix Documentation Link to Private Item in layout_2020 rustdoc: Fix some typos in components/layout_2020/table/mod.rs Mar 19, 2024
@mrobinson
Copy link
Member

I've just preserved the typo fixes here, because they are valid and I'd like to clear out some of the pending PRs.

@mrobinson mrobinson marked this pull request as ready for review March 19, 2024 07:55
@mrobinson mrobinson added this pull request to the merge queue Mar 19, 2024
Merged via the queue into servo:main with commit 03c11f7 Mar 19, 2024
12 checks passed
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.

None yet

2 participants