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

libsyntax: Enhance documentation of the AST module #65761

Merged
merged 1 commit into from
Oct 26, 2019
Merged

libsyntax: Enhance documentation of the AST module #65761

merged 1 commit into from
Oct 26, 2019

Conversation

popzxc
Copy link
Contributor

@popzxc popzxc commented Oct 24, 2019

This PR enhances documentation state to the libsyntax/ast.rs (as initiative caused by rustc-guide#474), by adding:

  • Module documentation.
  • Doc-comments (and a bit of usual comments) in non-obvious (as for me) places.
  • Minor style fixes to improve module readability.

@rust-highfive
Copy link
Collaborator

r? @eddyb

(rust_highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 24, 2019
Centril
Centril reviewed Oct 24, 2019
View reviewed changes
src/libsyntax/ast.rs Outdated Show resolved Hide resolved
src/libsyntax/ast.rs Outdated Show resolved Hide resolved
src/libsyntax/ast.rs Outdated Show resolved Hide resolved
src/libsyntax/ast.rs Outdated Show resolved Hide resolved
src/libsyntax/ast.rs Outdated Show resolved Hide resolved
src/libsyntax/ast.rs Outdated Show resolved Hide resolved
src/libsyntax/ast.rs Outdated Show resolved Hide resolved
@eddyb
Copy link
Member

eddyb commented Oct 24, 2019

r? @petrochenkov cc @matklad

@rust-highfive rust-highfive assigned petrochenkov and unassigned eddyb Oct 24, 2019
petrochenkov
petrochenkov reviewed Oct 24, 2019
View reviewed changes
src/libsyntax/ast.rs Outdated Show resolved Hide resolved
src/libsyntax/ast.rs Outdated Show resolved Hide resolved
src/libsyntax/ast.rs Outdated Show resolved Hide resolved
src/libsyntax/ast.rs Outdated Show resolved Hide resolved
src/libsyntax/ast.rs Outdated Show resolved Hide resolved
src/libsyntax/ast.rs Outdated Show resolved Hide resolved
src/libsyntax/ast.rs Show resolved Hide resolved
@petrochenkov petrochenkov added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 24, 2019
petrochenkov
petrochenkov reviewed Oct 25, 2019
View reviewed changes
src/libsyntax/ast.rs Outdated Show resolved Hide resolved
src/libsyntax/ast.rs Outdated Show resolved Hide resolved
src/libsyntax/ast.rs Outdated Show resolved Hide resolved
src/libsyntax/ast.rs Outdated Show resolved Hide resolved
@petrochenkov
Copy link
Contributor

r=me after addressing the remaining nits and squashing the commits.

@popzxc
libsyntax: Document ast module
ae5203a 
Apply review suggestions

Remove links in the module docs

Flatten imports

Apply review suggestions

Remove useless comments

Fix nits
@petrochenkov
Copy link
Contributor

Thanks!
@bors r+

@bors
Copy link
Contributor

bors commented Oct 26, 2019

📌 Commit ae5203a has been approved by petrochenkov

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Oct 26, 2019
@bors
Copy link
Contributor

bors commented Oct 26, 2019

⌛ Testing commit ae5203a with merge 1b84b6885ddfac975c24deefe908e4365b88a6b3...

@rust-highfive
Copy link
Collaborator

Your PR failed (pretty log, raw log). Through arcane magic we have determined that the following fragments from the build log may contain information about the problem.

Click to expand the log. 
2019-10-26T06:41:51.1335896Z Chocolatey installed 0/1 packages. 1 packages failed.
2019-10-26T06:41:51.1336016Z  See the log for details (C:\ProgramData\chocolatey\logs\chocolatey.log).
2019-10-26T06:41:51.1339362Z 
2019-10-26T06:41:51.1343989Z Failures
2019-10-26T06:41:51.1351536Z  - msys2 (exited 1) - msys2 not installed. An error occurred during installation:
2019-10-26T06:41:51.1351710Z  The remote server returned an error: (503) Server Unavailable. Service Unavailable
2019-10-26T06:41:51.6518368Z 
2019-10-26T06:41:51.6570564Z ##[error]Bash exited with code '1'.
2019-10-26T06:41:51.6760546Z ##[section]Starting: Upload CPU usage statistics
2019-10-26T06:41:51.6861240Z ==============================================================================
2019-10-26T06:41:51.6861358Z Task         : Bash
2019-10-26T06:41:51.6861444Z Description  : Run a Bash script on macOS, Linux, or Windows
---
2019-10-26T06:41:52.0178176Z ========================== Starting Command Output ===========================
2019-10-26T06:41:52.0179197Z [command]"C:\Program Files\Git\bin\bash.exe" --noprofile --norc /d/a/_temp/771d4433-a742-4c1f-bf9d-2f529b54fecc.sh
2019-10-26T06:41:52.0179318Z /d/a/_temp/771d4433-a742-4c1f-bf9d-2f529b54fecc.sh: line 1: aws: command not found
2019-10-26T06:41:52.0179426Z 
2019-10-26T06:41:52.0180789Z ##[error]Bash exited with code '127'.
2019-10-26T06:41:52.0198276Z ##[section]Starting: Checkout
2019-10-26T06:41:52.0296382Z ==============================================================================
2019-10-26T06:41:52.0296476Z Task         : Get sources
2019-10-26T06:41:52.0296575Z Description  : Get sources from a repository. Supports Git, TfsVC, and SVN repositories.

I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact @TimNN. (Feature Requests)

@bors
Copy link
Contributor

bors commented Oct 26, 2019

💔 Test failed - checks-azure

@bors bors added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Oct 26, 2019
@popzxc
Copy link
Contributor Author

popzxc commented Oct 26, 2019 •
edited
Loading

Hm?

The build was canceled by Alex Crichton.

@tesuji
Copy link
Contributor

tesuji commented Oct 26, 2019

@popzxc

2019-10-26T06:41:51.1343989Z Failures
2019-10-26T06:41:51.1351536Z  - msys2 (exited 1) - msys2 not installed. An error occurred during installation:
2019-10-26T06:41:51.1351710Z  The remote server returned an error: (503) Server Unavailable. Service Unavailable

@JohnTitor
Copy link
Member

It's a network error.
@bors retry

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 26, 2019
Centril added a commit to Centril/rust that referenced this pull request Oct 26, 2019
@Centril
Rollup merge of rust-lang#65761 - popzxc:document-ast, r=petrochenkov
d51a842 
libsyntax: Enhance documentation of the AST module

This PR enhances documentation state to the `libsyntax/ast.rs` (as initiative caused by [rustc-guide#474](rust-lang/rustc-dev-guide#474)), by adding:
- Module documentation.
- Doc-comments (and a bit of usual comments) in non-obvious (as for me) places.
- Minor style fixes to improve module readability.
@Centril Centril mentioned this pull request Oct 26, 2019
Merged
bors added a commit that referenced this pull request Oct 26, 2019
@bors
Auto merge of #65845 - Centril:rollup-28jtjfc, r=Centril
46e6c53 
Rollup of 8 pull requests

Successful merges:

 - #65743 (rustc_typeck: don't record direct callees in generator_interior.)
 - #65761 (libsyntax: Enhance documentation of the AST module)
 - #65772 (Remove the last remaining READMEs)
 - #65773 (Increase spacing for suggestions in diagnostics)
 - #65791 (Adding doc on keyword continue)
 - #65824 (rustc: make DefPathData (and friends) Copy (now that it uses Symbol).)
 - #65828 (Derive Eq and Hash for SourceInfo again)
 - #65842 (Add more information on rustdoc search)

Failed merges:

 - #65825 (rustc: use IndexVec<DefIndex, T> instead of Vec<T>.)

r? @ghost
@bors bors merged commit ae5203a into rust-lang:master Oct 26, 2019
@popzxc popzxc deleted the document-ast branch October 27, 2019 03:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Centril Centril Centril left review comments

@petrochenkov petrochenkov petrochenkov left review comments

Assignees

@petrochenkov petrochenkov

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@popzxc @rust-highfive @eddyb @petrochenkov @bors @tesuji @JohnTitor @Centril