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

Compiled documentation is out of date. #147

Open
Parakleta opened this issue Mar 3, 2016 · 6 comments
Open

Compiled documentation is out of date. #147

Parakleta opened this issue Mar 3, 2016 · 6 comments

Comments

@Parakleta
Copy link

The linked documentation at http://thehydroimpulse.github.io/nanomsg.rs/nanomsg/struct.Socket.html does not match the actual code in the repository (the type signature of read_to_end is what tripped me up).

@vks
Copy link
Contributor

vks commented Mar 21, 2016

Also NanoError and NanoResult don't exist anymore.

@thehydroimpulse
Copy link
Owner

@Parakleta Totally didn't see this until now. I'll look into this.

@lunemec
Copy link

lunemec commented Sep 9, 2016

You can have Travis auto-build the documentation from current git repository. There are several examples, and I'm using it on my own rust projects: https://github.com/lunemec/rust-num-digitize

The travis pushes the doc into separate git branch in this repository after each commit on master, then it is served by github pages.

@lunemec
Copy link

lunemec commented Sep 9, 2016

Oh, you already have gh-pages branch, which means the autobuild should work :) sorry, didn't notice..

@vks
Copy link
Contributor

vks commented Sep 9, 2016

@lunemec Now it seems like https://docs.rs/nanomsg is the best option.

@vks
Copy link
Contributor

vks commented Sep 9, 2016

I opened #157 which should fix this issue. Independently the current documentation seems to be up to date, so I think this issue can be closed.

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

No branches or pull requests

4 participants