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

[WIP] Add jsdoc to project #1758

Closed
wants to merge 9 commits into from
Closed

[WIP] Add jsdoc to project #1758

wants to merge 9 commits into from

Conversation

sabau
Copy link
Contributor

@sabau sabau commented Dec 19, 2018

Description:

  • update minor version of vue
  • examples of documentation in some modules
  • added command doc to package.json
  • explicitely working only on app/src files

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

- update minor version of vue
- examples of documentation
- added command `doc` to package.json
- explicitely working only on app/src files

Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com>
Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com>
Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com>
@codecov
Copy link

codecov bot commented Dec 19, 2018

Codecov Report

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

@@            Coverage Diff             @@
##           develop   #1758      +/-   ##
==========================================
- Coverage    97.71%   97.7%   -0.01%     
==========================================
  Files          103     102       -1     
  Lines         2100    2095       -5     
  Branches        93      93              
==========================================
- Hits          2052    2047       -5     
  Misses          39      39              
  Partials         9       9
Impacted Files Coverage Δ
app/src/renderer/vuex/store.js 100% <ø> (ø) ⬆️
app/src/renderer/App.vue 100% <ø> (ø) ⬆️
app/src/renderer/scripts/num.js 100% <ø> (ø) ⬆️
app/src/renderer/main.js 94.11% <ø> (ø) ⬆️
app/src/renderer/components/wallet/PageWallet.vue 91.66% <ø> (ø) ⬆️
app/src/renderer/google-analytics.js 33.33% <ø> (ø) ⬆️

@codecov
Copy link

codecov bot commented Dec 19, 2018

Codecov Report

❗ No coverage uploaded for pull request base (develop@d33ce3a). Click here to learn what that means.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             develop    #1758   +/-   ##
==========================================
  Coverage           ?   95.06%           
==========================================
  Files              ?      121           
  Lines              ?     2977           
  Branches           ?      128           
==========================================
  Hits               ?     2830           
  Misses             ?      137           
  Partials           ?       10
Impacted Files Coverage Δ
app/src/renderer/vuex/store.js 100% <ø> (ø)
app/src/renderer/App.vue 100% <ø> (ø)
app/src/renderer/scripts/num.js 100% <ø> (ø)
app/src/renderer/main.js 79.03% <ø> (ø)
app/src/renderer/components/wallet/PageWallet.vue 100% <ø> (ø)
app/src/renderer/google-analytics.js 33.33% <ø> (ø)

},

{ path: `/404`, component: common(`404`) },
{ path: `*`, component: common(`404`) }
{ path: `/404`, component: require(`./components/common/Page404`).default },
Copy link
Collaborator

Choose a reason for hiding this comment

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

nice

Copy link
Collaborator

@faboweb faboweb left a comment

Choose a reason for hiding this comment

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

Do we need to check in all the docs? Do we need some process to generate the docs?

@sabau
Copy link
Contributor Author

sabau commented Jan 3, 2019

Usually is more convenient to have the doc in the project, to have it more accessible, it can be also be compressed for older versions.

We could enforce it on cci of via git hook, as for now the command to update it manually:

yarn doc

@faboweb
Copy link
Collaborator

faboweb commented Jan 3, 2019

OK cool, going with it for now.

faboweb
faboweb previously approved these changes Jan 3, 2019
@fedekunze
Copy link
Contributor

fedekunze commented Jan 3, 2019

don't we need to update the README too?

@faboweb
Copy link
Collaborator

faboweb commented Jan 3, 2019

do we need to update the README ?

good point

@faboweb
Copy link
Collaborator

faboweb commented Jan 3, 2019

Let's halt the merge until further discussion

@sabau sabau changed the title Add jsdoc to project [DISCUSS] Add jsdoc to project Jan 4, 2019
@sabau sabau changed the title [DISCUSS] Add jsdoc to project [WIP] Add jsdoc to project Jan 8, 2019
Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com>
Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com>
Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com>
Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com>
@sabau sabau closed this Jan 9, 2019
@sabau
Copy link
Contributor Author

sabau commented Jan 9, 2019

I closed this one to have a cleaner single commit, just squashed the changes into another branch

@sabau sabau deleted the sabau/1739-jsdoc-spike branch January 9, 2019 11:04
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