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

Update decorators documentation #2127

Merged
merged 3 commits into from
Mar 8, 2020
Merged

Update decorators documentation #2127

merged 3 commits into from
Mar 8, 2020

Conversation

jsumners
Copy link
Member

@jsumners jsumners commented Mar 7, 2020

This resolves issue #2117.

In addition to resolving that issue, this PR refactors the decorators documentation completely by:

  1. Removing all informal language
  2. Moving anchors into correct position for editor code folding and proper browser anchor referencing
  3. Grouping API methods into a coherent list
  4. Moving relevant information into contiguous blocks instead of spread out over multiple sections

Checklist

  • run npm run test and npm run benchmark
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message and code follows Code of conduct

@jsumners jsumners requested review from a team March 7, 2020 13:58
@jsumners jsumners added the documentation Improvements or additions to documentation label Mar 7, 2020
mcollina
mcollina approved these changes Mar 7, 2020
View reviewed changes
Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

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

lgtm

delvedor
delvedor approved these changes Mar 7, 2020
View reviewed changes
Copy link
Member

@delvedor delvedor left a comment

Choose a reason for hiding this comment

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

Great work!

docs/Decorators.md Outdated Show resolved Hide resolved
@jsumners @delvedor
Update docs/Decorators.md
92c42a7 
Co-Authored-By: Tomas Della Vedova <delvedor@users.noreply.github.com>
@jsumners jsumners merged commit 2874af5 into master Mar 8, 2020
@jsumners jsumners deleted the issue-2117 branch March 8, 2020 02:05
This was referenced Mar 12, 2020
Merged
Open
This was referenced Apr 12, 2020
Merged
Merged
Closed
Merged
This was referenced May 5, 2020
Merged
Merged
Closed
Merged
@github-actions
Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 10, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@mcollina mcollina mcollina approved these changes

@delvedor delvedor delvedor approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@jsumners @mcollina @delvedor