Add documentation #18
Conversation
| @@ -12,6 +12,186 @@ | |||
| // See the License for the specific language governing permissions and | |||
| // limitations under the License. | |||
|
|
|||
| //! # Rust client guide | |||
There was a problem hiding this comment.
What is the advantage of doing this in lib.rs vs README.md?
There was a problem hiding this comment.
The only one would be that it will be added to the crate documentation when publishing. The readme could link to the documentation. Do you have any preferences?
There was a problem hiding this comment.
@marot is it possible to have the README be the "source of truth" and then have that added procedurally to the crate documentation? If that's too much fuss or not possible then having the readme link to the documentation sounds okay.
There was a problem hiding this comment.
Unfortunately, it is not too easy, because the examples contain code that is supposed to be hidden (setup code).
I will link to the documentation for now.
|
@marot could you add documentation on the thread safety of the client? |
|
Is this ready to be merged? |
|
Hi @ValorZard |
No description provided.