Hide the req_packed_commands from docs.
#1020
Conversation
`req_packed_commands` is meant for internal usage by the `Pipeline` object, and is an easy to misuse footgun. See redis-rs#1017 (comment)
|
What if we just update the docs to better explain the parameters and otherwise warn against using the method, as you've done here -- I wonder if that will accomplish the goal without hiding it completely? I'm not sure how likely it is, but it seems like hiding it might frustrate downstream users/libraries unnecessarily. |
|
As far as I understand the #[doc(hidden)] command, it just hides this from generated documentation. It doesn't prevent usage of this function - hence, no semver-breaking tag on this PR. So, I'm not sure what might cause frustration here - users who already use this function will be able to keep using it, and those that don't (and probably shouldn't) will have a harder time being aware of the function. Anyone who wants to implement |
I don't have a real strong opinion either, but it feels a bit wrong to me to hide methods of public traits from the documentation. I understand the reasoning though, so not opposed to it. |
req_packed_commandsis meant for internal usage by thePipelineobject, and is an easy to misuse footgun.See #1017 (comment)