Add api docs #12
Add api docs #12
Conversation
| /// use rrd::data::Data; | ||
| /// use rrd::Timestamp; | ||
| /// | ||
| /// let data = Data::new( |
There was a problem hiding this comment.
I don't think users should be creating Data, which makes this example inapplicable
| pub fn rows(&self) -> Rows<T> { | ||
| Rows { data: self } | ||
| } | ||
| } | ||
|
|
||
| pub struct DataSources<'data, T> |
There was a problem hiding this comment.
I tried to come up with documentation explaining what this type does, and couldn't really find a reason why it wasn't just a slice of strings.
| pub mod data; | ||
| pub mod error; | ||
| pub mod ops; | ||
| pub mod util; | ||
|
|
||
| pub use ops::fetch::fetch; | ||
| pub use ops::info::info; |
There was a problem hiding this comment.
It seemed weird to leave pub use for only these two operations
- Not including docs for every field -- I think it's reasonable for users to refer to the linked upstream docs for that. - Renamed `commands` to `elements` as it seemed a little closer to their nature, and the upstream docs use that term in a few places. - Removed data::DataSources and friends, as it didn't seem to be adding much
marshallpierce
force-pushed
the
mp/docs
branch
from
4f05a01 to
a7de938
Compare
|
Thanks a lot for all the PR's, it's very much appreciated. I'll be making a 0.2.0 release later this week, hopefully later today really. I was planning to add you to the authors section if you don't mind. I think you wrote the majority of the code by now. :) Let me know if your good with that. |
|
Thanks for being such a prompt collaborator :) I'd be happy to be an author -- might as well put this librrd knowledge to good use now that I've got it! |
|
So I added you to the authers section and expected you to show up somewhere on crates.io. But that doesn't seem to work. Should I do something extra? |
|
|
|
Invites received, thanks. Interestingly, the magic links inside worked even though that browser wasn't authenticated with crates.io at the time -- you'd think they would check the authenticated user == the invite recipient! Oh well, a problem for another day. |
|
That is interesting. But oh well, our goal is achieved. ;) |
commandstoelementsas it seemed a little closer to their nature, and the upstream docs use that term in a few places.