Skip to content
This repository has been archived by the owner on Dec 9, 2024. It is now read-only.

[SLF] : (JS-D1001) Documentation comments not found for functions and classes #342

Closed
SillyLittleCommits opened this issue Aug 14, 2024 · 1 comment · Fixed by #343
Closed

[SLF] : (JS-D1001) Documentation comments not found for functions and classes #342

SillyLittleCommits opened this issue Aug 14, 2024 · 1 comment · Fixed by #343
Assignees
@kiyarose
Labels
documentation Improvements or additions to documentation ds-minor easy Quick fix formatting Internal Something that will not be a visible web change javascript Pull requests that update Javascript code sillylittlefiles Issues Regarding the Main Website style triage-wfm Waiting for a PR
Milestone
DST: Cleanup 24

Comments

@SillyLittleCommits
Copy link
Collaborator

Description

It is recommended to have documentation comments above, or right inside a function/class declaration. This helps developers, users and even the author understand the purpose of a code snippet or API function in the future. NOTE: If you want to stop this issue from getting raised on certain constructs (arrow …

Occurrences

There are 16 occurrences of this issue in the repository.

See all occurrences on DeepSource → app.deepsource.com/gh/dswan36/SillyLittleFiles/issue/JS-D1001/occurrences/
@SillyLittleCommits SillyLittleCommits added documentation Improvements or additions to documentation style formatting sillylittlefiles Issues Regarding the Main Website Internal Something that will not be a visible web change javascript Pull requests that update Javascript code ds-minor labels Aug 14, 2024
@SillyLittleCommits SillyLittleCommits added this to the DST: Cleanup 24 milestone Aug 14, 2024
@kiyarose kiyarose added the easy Quick fix label Aug 14, 2024
@kiyarose
Copy link
Owner

Add documentation to functions
Gtag stuff is analytics
SW stuff is service workers (for prox[y] stuff)
Panic stuff is quickly exiting the page things

@kiyarose kiyarose added the triage-wfm Waiting for a PR label Aug 15, 2024
kiyarose pushed a commit that referenced this issue Aug 15, 2024
JSD1001 on star
e23f01a 
#342

Signed-off-by: Damian Swan <damian.swan@st.gactc.edu>
@kiyarose kiyarose mentioned this issue Aug 15, 2024
Merged
kiyarose pushed a commit that referenced this issue Aug 15, 2024
@deepsource-autofix @github-actions @restyled-commits
[ Smells ] : Cleanup code for DST (#343)
b72ddf8 
* JSD1001 on star

#342

Signed-off-by: Damian Swan <damian.swan@st.gactc.edu>

* style: format code with Prettier and StandardJS

This commit fixes the style issues introduced in e23f01a according to the output
from Prettier and StandardJS.

Details: #343

* JS0246 @ cca202e

Signed-off-by: Damian Swan <damian.swan@st.gactc.edu>

* Restyled [ Smells ] : Cleanup code for DST (#344)

Co-authored-by: Restyled.io <commits@restyled.io>
Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com>

* Restyled [ Smells ] : Cleanup code for DST (#345)

* Restyled by clang-format

* Restyled by prettier

* style: format code with Prettier and StandardJS

This commit fixes the style issues introduced in 07efd94 according to the output
from Prettier and StandardJS.

Details: #345

---------

Co-authored-by: Restyled.io <commits@restyled.io>
Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com>

---------

Signed-off-by: Damian Swan <damian.swan@st.gactc.edu>
Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Restyled.io <commits@restyled.io>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@kiyarose kiyarose

Labels
documentation Improvements or additions to documentation ds-minor easy Quick fix formatting Internal Something that will not be a visible web change javascript Pull requests that update Javascript code sillylittlefiles Issues Regarding the Main Website style triage-wfm Waiting for a PR
Projects
None yet
Milestone
DST: Cleanup 24
Development

Successfully merging a pull request may close this issue.

[ Smells ] : Cleanup code for DST kiyarose/SillyLittleFiles
2 participants
@kiyarose @SillyLittleCommits