mirrors/arti.git/crates, branch arti-v0.0.1 mirror of https://gitlab.torproject.org/tpo/core/arti http://git.dilluti0n.com/mirrors/arti.git/atom?h=arti-v0.0.1 2021-10-29T15:41:26Z tor-persist: serde usage now requires derive feature. 2021-10-29T15:41:26Z Nick Mathewson nickm@torproject.org 2021-10-29T15:41:26Z urn:sha1:f5d042115a99ec0dde5dc0466dd9cab916baa6c1 Bump all crate versions to 0.0.1 2021-10-29T15:05:51Z Nick Mathewson nickm@torproject.org 2021-10-29T15:05:51Z urn:sha1:e6e740646ac61c9f06dc332cc156d4b20e793b70 Update README.md files 2021-10-29T13:37:15Z Nick Mathewson nickm@torproject.org 2021-10-29T13:37:15Z urn:sha1:9d3256ec8370dbe8731acbc7619c4b2bf4f09f17 Merge remote-tracking branch 'origin/mr/112' 2021-10-29T13:16:44Z Nick Mathewson nickm@torproject.org 2021-10-29T13:16:44Z urn:sha1:19a61249f872f38ff78eee4176c2d1772e895242 Improve docs of more (potentially re-exported) arti-client types 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. Improve some documentation links 2021-10-29T12:39:04Z Nick Mathewson nickm@torproject.org 2021-10-29T12:39:04Z urn:sha1:1ee24ce6537373448d8fd5fb074768c6887cb90b Instead of putting a fully qualified name in the text, in most cases we should just use the short name of the type or function we're referring to. In other words, instead of saying [`crate::module::Foo`], we should typically say [`Foo`](crate::module::Foo). Try writing a bit more documentation for configuration types. 2021-10-29T00:49:17Z Nick Mathewson nickm@torproject.org 2021-10-29T00:49:17Z urn:sha1:c11fe200d18d95eb1100dae6c21d02a93c5727b0 Use correct link for AsyncWriteExt::flush 2021-10-29T00:48:54Z Nick Mathewson nickm@torproject.org 2021-10-29T00:48:54Z urn:sha1:2057142671c4ced0828c85b01dae02b9b1f0b172 Typo fix in an expect() message. 2021-10-29T00:22:49Z Nick Mathewson nickm@torproject.org 2021-10-29T00:22:49Z urn:sha1:4107533d77e51d9653d76dabbd893197fb176c65 Encourage the use of TorClient::clone(). 2021-10-29T00:21:35Z Nick Mathewson nickm@torproject.org 2021-10-29T00:19:54Z urn:sha1:6cba1acef40d4ddad5716bc8c93eab1436a82dda