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 documentation TODO entries #640

Merged
merged 1 commit into from Jul 8, 2017

Conversation

Projects
None yet
3 participants
@hczhcz
Member

hczhcz commented Jul 8, 2017

It would be helpful when using some documentation generators. At least, there would be a complete list of functions/methods

BTW, I would suggest that merging the Wiki and the /docs is good to new users.

@coveralls

This comment has been minimized.

Show comment
Hide comment
@coveralls

coveralls Jul 8, 2017

Coverage Status

Changes Unknown when pulling 6596187 on hczhcz:master into ** on Chatie:master**.

coveralls commented Jul 8, 2017

Coverage Status

Changes Unknown when pulling 6596187 on hczhcz:master into ** on Chatie:master**.

@zixia

This comment has been minimized.

Show comment
Hide comment
@zixia

zixia Jul 8, 2017

Member

Yes, I agree with you. The document should be generated from the source code, which will be fully synced with the latest version. We had some discussion about it, see #73 #252.

And I also agree with you about merging the Wiki API page to /docs. Because the Wiki page is created before we decide to use jsdoc to document Wechaty. Now we have the plan to do this, so I believe as soon as we merged the API docs to the jsdoc, we should redirect the Wiki page to /docs, which is good for new users.

I appreciate your PR for moving this forward: add a @todo is a good start. More contributions are very welcome. Thanks!

Member

zixia commented Jul 8, 2017

Yes, I agree with you. The document should be generated from the source code, which will be fully synced with the latest version. We had some discussion about it, see #73 #252.

And I also agree with you about merging the Wiki API page to /docs. Because the Wiki page is created before we decide to use jsdoc to document Wechaty. Now we have the plan to do this, so I believe as soon as we merged the API docs to the jsdoc, we should redirect the Wiki page to /docs, which is good for new users.

I appreciate your PR for moving this forward: add a @todo is a good start. More contributions are very welcome. Thanks!

@zixia zixia merged commit f906d7a into Chatie:master Jul 8, 2017

6 of 7 checks passed

continuous-integration/appveyor/pr AppVeyor build failed
Details
ci/circleci Your tests passed on CircleCI!
Details
codacy/pr Good work! A positive pull request.
Details
codeclimate no new or fixed issues
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
coverage/coveralls First build on master at 54.647%
Details
security/snyk No new vulnerabilities
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment