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

Auto-generated documentation with TSDocs #30

Closed
holgerd77 opened this issue Jan 10, 2019 · 1 comment
Closed

Auto-generated documentation with TSDocs #30

holgerd77 opened this issue Jan 10, 2019 · 1 comment

Comments

@holgerd77
Copy link
Member

Documentation of this library should be auto-generated with TypeDoc, this PR ethereumjs/ethereumjs-util#170 can serve as a reference (see also technical docs on documentation).

For this the manual documentation comments in the README (https://github.com/ethereumjs/ethereumjs-account) should be integrated in the code along the way. The code examples should either kept integrated or separated, whichever makes more sense respectively is more practical.

Depends on #27

@holgerd77
Copy link
Member Author

@s1na Have labelled this "good first issue" and "help wanted", this doesn't mean that you can't take on this if you want which would also make sense since you did the preparatory TypeScript work.

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

No branches or pull requests

1 participant