mirror of https://gitlab.torproject.org/tpo/core/arti http://git.dilluti0n.com/mirrors/arti.git/atom?h=arti-v0.0.1 2021-10-29T13:06:06Z 2021-10-29T13:06:06Z eta tor@eta.st 2021-10-29T13:06:06Z urn:sha1:a12fffc66accb0126500280f540b09c0922c1145 Most of the structs in `arti-client` have example code now, to give a clearer idea of how they're used. Annoyingly, a lot of the types exposed in `arti-client` are actually re-exports, which makes documentation a bit harder: example code that references other parts of `arti-client` can't actually be run as a doctest, since the crate it's in is a dependency of `arti-client`. We might be able to fix this in future by doing the documentation in `arti-client` itself, but rustdoc seems to have some weird behaviours there that need to be investigated first (for example, it seems to merge the re-export and original documentation, and also put the re-export documentation on the `impl` block for some reason). For now, though, this commit just writes the docs from the point of view of an `arti-client` consumer, removing notes specific to the crate in which they're defined. It's not ideal, but at least the end user experience is decent. 2021-10-29T00:20:23Z Nick Mathewson nickm@torproject.org 2021-10-29T00:18:04Z urn:sha1:bf3bfdf62de9a0d2500da30ad986d4d4bf31e9f5 I'm not 100% sure this is better, but it might help the user understand how Arti works a bit better. 2021-10-28T18:20:42Z eta tor@eta.st 2021-10-28T17:32:49Z urn:sha1:dcdd8c59dfa6afd3ee903d5eacab4a99c1258e7d This overhauls the top-level `arti-client` documentation significantly: - the "Using arti-client" section walks the user through all of the necessary steps to initiate a Torified TCP connection, and then provides a code example - this example is also available as `examples/readme.rs`; it's not run as a doctest, since it involves connecting to Tor - a "More advanced usage" subheading provides information about stream isolation (and can potentially be used for other interesting features once we get them). - a new "Multiple runtime support" section was added to explain the purpose and usage of the `tor-rtcompat` crate - the section on design and privacy considerations was removed; this is probably okay to keep in a README, but users of the crate aren't going to be interested in this (at least I don't think) (also, the doc comment for `arti_client::Error` was fixed to make actual sense) 2021-10-27T15:13:46Z Nick Mathewson nickm@torproject.org 2021-10-27T15:13:46Z urn:sha1:134c04a67adebff719011b608dabfa6da60ed247 2021-10-25T12:40:00Z Nick Mathewson nickm@torproject.org 2021-10-25T12:40:00Z urn:sha1:b477f12d83f0e2ea50819f31748e8756110d6718 2021-10-21T18:22:11Z Nick Mathewson nickm@torproject.org 2021-10-21T18:15:13Z urn:sha1:7c7a388e287afa0e168d8d666da6649a5750b9b5 Solves a name conflict with the existing tor_client create. Closes #130.