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

Update the 'outline-view' documentation #6454

Merged
merged 1 commit into from
Nov 1, 2019

Conversation

vince-fugnitto
Copy link
Member

What it does

  • updates the documentation for the outline-view.
  • in order to globally update the documentation for all tree-widgets,
    including the outline-view-widget, the tree-widget.tsx documentation
    was updated from @theia/core.

The following additional tslint checks were added to the errors.tslint.json during development, and the documentation was updated in order to make the build pass.

"rules": {
    "completed-docs": [true, "enums", "enum-members", "functions", "interfaces", "methods"],
    "no-redundant-jsdoc": true,
}

How to test

Verify the documentation.

Review checklist

Reminder for reviewers

Signed-off-by: Vincent Fugnitto vincent.fugnitto@ericsson.com

@vince-fugnitto vince-fugnitto added outline issues related to the outline documentation issues related to documentation labels Oct 28, 2019
@vince-fugnitto vince-fugnitto self-assigned this Oct 28, 2019
@akosyakov
Copy link
Member

I'm fine merging such PRs. But i'm not going to write and update such docs. I don't see any new information from such docs, except repetition of method names and parameters.

@vince-fugnitto
Copy link
Member Author

@akosyakov I understand your point, documentation should in fact bring extra value and should accurately describe the non-trivial parts of a method. I'll try to update the documentation to be more descriptive and thorough and attempt to explain internally what the methods perform.

Thank you for the feedback!

- updates the documentation for the `outline-view`.
- in order to globally update the documentation for all `tree-widgets`,
including the `outline-view-widget`, the `tree-widget.tsx` documentation
was updated from `@theia/core`.

Signed-off-by: Vincent Fugnitto <vincent.fugnitto@ericsson.com>
@vince-fugnitto
Copy link
Member Author

@elaihau you can verify the PR now. I've updated the documentation and am open to more feedback.

@vince-fugnitto
Copy link
Member Author

@elaihau thank you for the review!

@vince-fugnitto vince-fugnitto merged commit 05f2e07 into master Nov 1, 2019
@vince-fugnitto vince-fugnitto deleted the vf/update-outline-view-docs branch November 1, 2019 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation issues related to documentation outline issues related to the outline
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants