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

Fix rustdoc errors in components/layout_2020 #31624

Closed
wants to merge 12 commits into from

Conversation

Aaryakhandelwal
Copy link
Contributor

@Aaryakhandelwal Aaryakhandelwal commented Mar 12, 2024

1)There were no function named as LineItems, thus removed the link syntax.
2) There was no variant named as Anonymous within the Fragment, thus removed the link syntax


  • There are tests for these changes OR
  • These changes do not require tests because they don't effect any functionality and just fixes the documentation.

@atbrakhi atbrakhi changed the title Fix rustdoc errors in components/layout_2020 Fix rustdoc errors in components/layout_2020 Mar 12, 2024
@@ -173,7 +173,7 @@ struct LineUnderConstruction {
/// offset from `text-indent`.
start_position: LogicalVec2<Length>,

/// The current inline position in the line being laid out into [`LineItems`] in this
/// The current inline position in the line being laid out into LineItems in this
Copy link
Member

Choose a reason for hiding this comment

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

Converting [`LineItems`] to LineItems is not the correct solution here. This should be [`LineItem`]s instead. For reference you can see some examples here

@@ -187,7 +187,7 @@ struct LineUnderConstruction {
has_content: bool,

/// Whether or not there are floats that did not fit on the current line. Before
/// the [`LineItems`] of this line are laid out, these floats will need to be
/// the LineItems of this line are laid out, these floats will need to be
Copy link
Member

Choose a reason for hiding this comment

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

same as above

@@ -604,7 +604,7 @@ pub(super) struct InlineFormattingContextState<'a, 'b> {
/// of the inline box is the state popped from the stack.
inline_box_state_stack: Vec<InlineBoxContainerState>,

/// A vector of fragment that are laid out. This includes one [`Fragment::Anonymous`]
/// A vector of fragment that are laid out. This includes one Fragment::Anonymous
Copy link
Member

Choose a reason for hiding this comment

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

we should not remove [` and `], we still want it to be a link. Anonymous was removed in this PR hence Rust doc is complaining, this should be [` Fragment::Positioning `] now.

@Aaryakhandelwal
Copy link
Contributor Author

Should I create a new pull request with the changes

@mrobinson
Copy link
Member

Should I create a new pull request with the changes

You should update this pull request with the new version of your changes. See mislav/hub#198.

@Aaryakhandelwal
Copy link
Contributor Author

Should I create a new pull request with the changes

You should update this pull request with the new version of your changes. See mislav/hub#198.

Yes I did, could you check once

@mrobinson
Copy link
Member

Yes I did, could you check once

Your change now includes unrelated changes from other PRs. Do you mind rebasing it onto the latest from the main branch and making sure it just includes the changes you are trying to make?

Aaryakhandelwal and others added 6 commits March 13, 2024 07:05
* Add wpt-report artifact

* Merge logs (filtered) are last so we still get other logs merged

* fixup

* it's wptreport.json

* wptreport in full artifact

* Apply suggestions from code review

Co-authored-by: Martin Robinson <mrobinson@igalia.com>

---------

Co-authored-by: Martin Robinson <mrobinson@igalia.com>
@Aaryakhandelwal
Copy link
Contributor Author

Yes I did, could you check once

Your change now includes unrelated changes from other PRs. Do you mind rebasing it onto the latest from the main branch and making sure it just includes the changes you are trying to make?

I have re based it to the updated main branch. I can see the updated changes in my system locally. Could you check it once, if it's alright.

@mrobinson
Copy link
Member

I have re based it to the updated main branch. I can see the updated changes in my system locally. Could you check it once, if it's alright.

No, it still seems to include too many changes. I recommend not doing any merges from main when creating a pull request. If you look at the "Files changed" tab in GitHub you can see that there are too many changes included in this PR due to the merge commits in your branch. The simplest thing to do now might be to redo these changes in a new PR.

@Aaryakhandelwal
Copy link
Contributor Author

Aaryakhandelwal commented Mar 13, 2024 via email

@Aaryakhandelwal Aaryakhandelwal deleted the Contribution2 branch March 13, 2024 10:12
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

4 participants