Closed giarc3 closed 4 years ago
Should there be some changes in the lib.rs
"Document Operations" section, similar to what we did in the "User Operations"?
Should there be some changes in the
lib.rs
"Document Operations" section, similar to what we did in the "User Operations"?
I haven't gotten to the "User Operations" section yet, but I did a re-write of "Document Operations" last ticket. This PR is just filling in the things I forgot to do from that ticket (though you did notice those missing parts at the time).
Should there be some changes in the
lib.rs
"Document Operations" section, similar to what we did in the "User Operations"?I haven't gotten to the "User Operations" section yet, but I did a re-write of "Document Operations" last ticket. This PR is just filling in the things I forgot to do from that ticket (though you did notice those missing parts at the time).
Gotcha. I am just saying that as part of this second round of cleanup, it might be nice to think about putting some more links, at least to the DocumentOps trait, in the lib.rs comment block. If a user is looking at the main page of the crate, it might help them find where they want to go. Or maybe we want to rework the main doc page altogether? I'm just trying to think of ways to get people into the right section of the docs more quickly.
EDIT: It looks like you did add a link to DocumentOps
in the group docs PR. So this is probably moot.
Improve the documentation for all of the
document
module types.Also added some convenience
From/TryFrom
implementations we were missing (DocumentName
,UserOrGroup
)