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

Constellation documentation comments #14698

Merged
merged 1 commit into from Dec 24, 2016
Merged

Conversation

@asajeffrey
Copy link
Member

asajeffrey commented Dec 23, 2016

Rewrote the documentation comments for constellation.rs.


  • ./mach build -d does not report any errors
  • ./mach test-tidy does not report any errors
  • These changes do not require tests because it's just documentation

This change is Reviewable

@asajeffrey
Copy link
Member Author

asajeffrey commented Dec 23, 2016

cc @Ms2ger. r? @ConnorGBrewster

@highfive highfive assigned cbrewster and unassigned Ms2ger Dec 23, 2016
@asajeffrey
Copy link
Member Author

asajeffrey commented Dec 23, 2016

Going through tidying this up generated a bunch of issues: #14690, #14691, #14692, #14693, #14694, and #14696.

Copy link
Member

cbrewster left a comment

Looks good other than a couple nits.

}
}
/// Whether the constellation supports the clipboard.
/// TODO: this field is not used, remove it?

This comment has been minimized.

@cbrewster

cbrewster Dec 23, 2016

Member

This is due to #7578 (PR #12507). I suppose we could remove it and re-add it when clipboard support is added again, or just leave it for now.

This comment has been minimized.

@asajeffrey

asajeffrey Dec 23, 2016

Author Member

Just leave it I think.

/// Represents a pending change in the frame tree, that will be applied
/// once the new pipeline has loaded and completed initial layout / paint.
struct FrameChange {
/// The frame to change.

This comment has been minimized.

@cbrewster

cbrewster Dec 23, 2016

Member

nit: remove this line and add a new line below frame_id

This comment has been minimized.

@asajeffrey

asajeffrey Dec 23, 2016

Author Member

Oops. Done.

@@ -684,6 +877,8 @@ impl<Message, LTF, STF> Constellation<Message, LTF, STF>
}
}

/// The joint session future is the merge of the session future of every
/// frame in the frame tree, sorted chronologically.

This comment has been minimized.

@cbrewster

cbrewster Dec 23, 2016

Member

Reverse chronologically?

This comment has been minimized.

@asajeffrey

asajeffrey Dec 23, 2016

Author Member

Done.

@asajeffrey asajeffrey force-pushed the asajeffrey:constellation-docs branch from 52ce028 to 1fbb23d Dec 23, 2016
@asajeffrey
Copy link
Member Author

asajeffrey commented Dec 23, 2016

Squashed. @bors-servo r=ConnorGBrewster

@bors-servo
Copy link
Contributor

bors-servo commented Dec 23, 2016

📌 Commit 1fbb23d has been approved by ConnorGBrewster

@bors-servo
Copy link
Contributor

bors-servo commented Dec 23, 2016

Testing commit 1fbb23d with merge 8805600...

bors-servo added a commit that referenced this pull request Dec 23, 2016
Constellation documentation comments

<!-- Please describe your changes on the following line: -->

Rewrote the documentation comments for `constellation.rs`.

---
<!-- Thank you for contributing to Servo! Please replace each `[ ]` by `[X]` when the step is complete, and replace `__` with appropriate data: -->
- [X] `./mach build -d` does not report any errors
- [X] `./mach test-tidy` does not report any errors
- [X] These changes do not require tests because it's just documentation

<!-- Pull requests that do not address these steps are welcome, but they will require additional verification as part of the review process. -->

<!-- Reviewable:start -->
---
This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/servo/14698)
<!-- Reviewable:end -->
@bors-servo
Copy link
Contributor

bors-servo commented Dec 23, 2016

💔 Test failed - mac-rel-wpt1

@asajeffrey
Copy link
Member Author

asajeffrey commented Dec 23, 2016

@bors-servo retry

  • CI weirdness
@bors-servo
Copy link
Contributor

bors-servo commented Dec 23, 2016

Testing commit 1fbb23d with merge 01a8ac3...

bors-servo added a commit that referenced this pull request Dec 23, 2016
Constellation documentation comments

<!-- Please describe your changes on the following line: -->

Rewrote the documentation comments for `constellation.rs`.

---
<!-- Thank you for contributing to Servo! Please replace each `[ ]` by `[X]` when the step is complete, and replace `__` with appropriate data: -->
- [X] `./mach build -d` does not report any errors
- [X] `./mach test-tidy` does not report any errors
- [X] These changes do not require tests because it's just documentation

<!-- Pull requests that do not address these steps are welcome, but they will require additional verification as part of the review process. -->

<!-- Reviewable:start -->
---
This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/servo/14698)
<!-- Reviewable:end -->
@bors-servo
Copy link
Contributor

bors-servo commented Dec 23, 2016

💔 Test failed - mac-rel-css

@asajeffrey
Copy link
Member Author

asajeffrey commented Dec 23, 2016

@jdm says this is servo/saltfs#565

@asajeffrey
Copy link
Member Author

asajeffrey commented Dec 23, 2016

YOLO @bors-servo retry

@jdm
Copy link
Member

jdm commented Dec 24, 2016

@bors-servo retry

@bors-servo
Copy link
Contributor

bors-servo commented Dec 24, 2016

Testing commit 1fbb23d with merge 0271793...

bors-servo added a commit that referenced this pull request Dec 24, 2016
Constellation documentation comments

<!-- Please describe your changes on the following line: -->

Rewrote the documentation comments for `constellation.rs`.

---
<!-- Thank you for contributing to Servo! Please replace each `[ ]` by `[X]` when the step is complete, and replace `__` with appropriate data: -->
- [X] `./mach build -d` does not report any errors
- [X] `./mach test-tidy` does not report any errors
- [X] These changes do not require tests because it's just documentation

<!-- Pull requests that do not address these steps are welcome, but they will require additional verification as part of the review process. -->

<!-- Reviewable:start -->
---
This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/servo/14698)
<!-- Reviewable:end -->
@bors-servo bors-servo merged commit 1fbb23d into servo:master Dec 24, 2016
3 checks passed
3 checks passed
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
homu Test successful
Details
}

/// Stores the navigation context for a single frame in the frame tree.
/// A frame in the frame tree.
/// Each frame is the constrellation's view of a browsing context.

This comment has been minimized.

@Ms2ger

Ms2ger Dec 25, 2016

Contributor

constrellation

This comment has been minimized.

@asajeffrey

asajeffrey Dec 25, 2016

Author Member

Oops.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

6 participants
You can’t perform that action at this time.