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

Standardize JSDoc formatting #244

Merged
merged 6 commits into from
Mar 3, 2020
Merged

Standardize JSDoc formatting #244

merged 6 commits into from
Mar 3, 2020

Conversation

eritbh
Copy link
Member

@eritbh eritbh commented Mar 2, 2020 •
edited
Loading

Following some Discord discussion, this PR converts our existing JSDoc comments to a format that we now document for consistency.

Guidelines themselves have been added to the wiki.

@creesch creesch merged commit 65afb24 into master Mar 3, 2020
@eritbh eritbh deleted the jsdoc-standardization branch March 4, 2020 17:05
@eritbh eritbh added this to the v5.3 milestone Mar 10, 2020
eritbh added a commit that referenced this pull request Sep 5, 2024
@eritbh
Standardize JSDoc formatting (#244)
0c5bf17 
* Start standardizing use of `@function` in JSDocs

* Add explicit @function tag in TBApi

* Doc consistency in TBLog (kinda)

* @function consistency and line lengths in TBui

* More doc line length stuff

* Update contributing wiki links to full URLs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
code quality
Projects
None yet
Milestone
v5.3
Development

Successfully merging this pull request may close these issues.
2 participants
@eritbh @creesch