Doc comments & generated API docs #182
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
do we have a copy of the generated docs up anywhere public? |
|
yeah, it's at https://mediachain.github.io/aleph/ |
|
馃憤 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a bunch of jsdoc comments to most of the code in
src/peer, and annpm run build:docscommand to generate HTML docs using the jsdoc cli tool & a docstrap template.I also added
npm run check:styleandnpm run check:typesscripts, mostly so that I can easily run the version of flow that's bundled as a dev dependency; @parkan I think that the Buffer / Array errors you were seeing only occur on flow 0.37, but things seem to check out with 0.38 which is installed as theflow-bindev dependency.The 107 files changed 馃槢 is due to committing the generated docs... I kind of went back and forth on that but it will let us point github pages at the
docsdir and easily host them without using agh_pagesbranch. I'm fine with adding a script to build and commit to thegh_pagesbranch though, if having the built docs on master is too annoying.