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

QDOC: show documentation for keyword like elements #6492

Merged
merged 4 commits into from Dec 21, 2020

Conversation

Undin
Copy link
Member

@Undin Undin commented Dec 7, 2020

Current changes allow opening quick documentation for keyword like elements.
But for self, super, crate and Self documentation won't be shown if they are part of a path. I suppose documentation for the referenced element is more important than documentation about keywords in such cases

Note, currently, if documentation contains a link to a keyword, the plugin can't open the corresponding quick doc. Will be fixed in separate PR.

changelog: show quick documentation for keyword like elements like fn, enum, async, etc.

@Undin Undin added the feature label Dec 7, 2020
@Undin Undin added this to In Progress in To test via automation Dec 7, 2020
@Undin Undin removed this from In Progress in To test Dec 7, 2020
@Undin Undin force-pushed the undin/keyword-documentation branch from 94b758d to ed4bd4e Compare December 21, 2020 15:04
Copy link
Member

@mchernyavsky mchernyavsky left a comment

Choose a reason for hiding this comment

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

bors r+

bors bot added a commit that referenced this pull request Dec 21, 2020
6492: QDOC: show documentation for keyword like elements r=mchernyavsky a=Undin

Current changes allow opening quick documentation for [keyword](https://doc.rust-lang.org/stable/std/#keywords) like elements.
But for `self`, `super`, `crate` and `Self` documentation won't be shown if they are part of a path. I suppose documentation for the referenced element is more important than documentation about keywords in such cases

Note, currently, if documentation contains a link to a keyword, the plugin can't open the corresponding quick doc. Will be fixed in separate PR.

changelog: show [quick documentation](https://www.jetbrains.com/help/idea/viewing-reference-information.html#inline-quick-documentation) for [keyword](https://doc.rust-lang.org/stable/std/#keywords) like elements like `fn`, `enum`, `async`, etc.

Co-authored-by: Arseniy Pendryak <a.pendryak@yandex.ru>
@bors
Copy link
Contributor

bors bot commented Dec 21, 2020

Build failed:

  • check

@Undin
Copy link
Member Author

Undin commented Dec 21, 2020

bors retry

@bors
Copy link
Contributor

bors bot commented Dec 21, 2020

Build succeeded:

@bors bors bot merged commit 7ec38af into master Dec 21, 2020
@bors bors bot deleted the undin/keyword-documentation branch December 21, 2020 17:09
@github-actions github-actions bot added this to the v138 milestone Dec 21, 2020
bors bot added a commit that referenced this pull request May 25, 2022
8872: QDOC: avoid NPE during documentation generation r=mchernyavsky a=Undin

Fixes the bug introduced in #6492

Fixes #8732

changelog: Don't throw `NullPointerException` during quick documentation generation in some cases


Co-authored-by: Arseniy Pendryak <a.pendryak@yandex.ru>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants