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

Add JSDoc as good practice #1813

Merged
merged 2 commits into from
Jan 10, 2019
Merged

Add JSDoc as good practice #1813

merged 2 commits into from
Jan 10, 2019

Conversation

sabau
Copy link
Contributor

@sabau sabau commented Jan 9, 2019

Description:

  • examples of documentation in some modules
  • added command doc to package.json
  • explicitely working only on app/src files
  • currently ignoring the generated documentation, until it's perceived as really useful

Closes #1739

Once we are in a presentable state we may link this in the wiki along with our README

❤️ Thank you!


  • Added entries in CHANGELOG.md with issue # and GitHub username
  • Reviewed Files changed in the github PR explorer

Signed-off-by: Karoly Albert Szabo <[email protected]>
Copy link
Contributor

@fedekunze fedekunze left a comment

Choose a reason for hiding this comment

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

LGTM

@codecov
Copy link

codecov bot commented Jan 10, 2019

Codecov Report

Merging #1813 into develop will decrease coverage by <.01%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           develop    #1813      +/-   ##
===========================================
- Coverage    94.85%   94.84%   -0.01%     
===========================================
  Files          123      122       -1     
  Lines         2954     2949       -5     
  Branches       121      121              
===========================================
- Hits          2802     2797       -5     
  Misses         143      143              
  Partials         9        9
Impacted Files Coverage Δ
app/src/renderer/scripts/num.js 100% <ø> (ø) ⬆️
app/src/renderer/components/wallet/PageWallet.vue 100% <ø> (ø) ⬆️
app/src/renderer/vuex/store.js 100% <ø> (ø) ⬆️
app/src/renderer/App.vue 100% <ø> (ø) ⬆️
app/src/renderer/main.js 79.03% <ø> (ø) ⬆️
app/src/renderer/google-analytics.js 33.33% <ø> (ø) ⬆️

1 similar comment
@codecov
Copy link

codecov bot commented Jan 10, 2019

Codecov Report

Merging #1813 into develop will decrease coverage by <.01%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           develop    #1813      +/-   ##
===========================================
- Coverage    94.85%   94.84%   -0.01%     
===========================================
  Files          123      122       -1     
  Lines         2954     2949       -5     
  Branches       121      121              
===========================================
- Hits          2802     2797       -5     
  Misses         143      143              
  Partials         9        9
Impacted Files Coverage Δ
app/src/renderer/scripts/num.js 100% <ø> (ø) ⬆️
app/src/renderer/components/wallet/PageWallet.vue 100% <ø> (ø) ⬆️
app/src/renderer/vuex/store.js 100% <ø> (ø) ⬆️
app/src/renderer/App.vue 100% <ø> (ø) ⬆️
app/src/renderer/main.js 79.03% <ø> (ø) ⬆️
app/src/renderer/google-analytics.js 33.33% <ø> (ø) ⬆️

@sabau sabau merged commit 06cfa74 into develop Jan 10, 2019
@sabau sabau deleted the sabau/1739-jsdoc branch January 10, 2019 14:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants