Skip to content
This repository has been archived by the owner on Apr 6, 2020. It is now read-only.

Typedoc generated docs #98

Merged
merged 6 commits into from
Apr 19, 2019
Merged

Typedoc generated docs #98

merged 6 commits into from
Apr 19, 2019

Conversation

alcuadrado
Copy link
Member

@alcuadrado alcuadrado commented Apr 18, 2019

This PR fixes #95, updating the docs to be compatible with the ethereumjs-config setup.

It mostly moves the docs from the README.md to the sources, with some formatting changes.

Note I didn't find places where the doc was outdated, but I'm not that familiar with this library yet, so I may have missed something.

Finally, I'm not sure how to document Blockchain.prototype.db, Blockchain.prototype.dbManager, and Blockchain.prototype.ethash. I suspect they should have been private fields. Apart from that, it is ready for review.

@alcuadrado
Copy link
Member Author

Oops, my bad. I didn't realized that those new privates were actually changing the code, and not just docs.

Some tests broke because of this. They were using private APIs, so I'm not sure what's the best way to move forward.

The easiest way of fixing this is to make things public again, and ignore them with the @hidden tsdoc tag.

@alcuadrado
Copy link
Member Author

The easiest way of fixing this is to make things public again, and ignore them with the @hidden tsdoc tag.

I went ahead and implemented this to keep this PR small.

Copy link
Member

@holgerd77 holgerd77 left a comment

Choose a reason for hiding this comment

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

Great thanks, together with the TS update from @whymarrh really a milestone for this library, will directly prepare some release PR so that we can get this out! 😀

Some notes:

  • This large inlined doc comment on the constructor should be broken down and especially the opts dict described by annotation tags, the deprecation note can probably be dropped
  • This hidden tagging is not so beautiful and bloats the code especially on private variables, we should eventually dig deeper if this can be alternatively addressed

Both no blockers though, we can handle in subsequent PRs iteratively.

@holgerd77 holgerd77 merged commit 3dd0ffb into master Apr 19, 2019
@holgerd77 holgerd77 deleted the tsdocs-docs branch April 19, 2019 08:32
@holgerd77
Copy link
Member

Some other notes:

  • we should eventually extract the example again to the main readme, think this is more friendly and makes the library more approachable
  • There is still Constantinople referenced as latest HF option in the constructor, this should be updated to Petersburg

@holgerd77
Copy link
Member

(these can also be addressed later/separate)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Auto-generated documentation with TSDocs
2 participants