vincenzopalazzo
/
arti
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

arti-client, tor-config: Remove stability warning from top-level docs 

Ticket #285 is closed and most of this is stable now we think.

(There are still a couple of stability warnings for specific types in
tor-config, which aren't exposed at the arti-client level.)
This commit is contained in:
Ian Jackson 2022-11-21 12:05:37 +00:00
parent 3520505a2c
commit 0b14b93f76
2 changed files with 0 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
crates/arti-client/src/config.rs
View File

@ -355,15 +355,6 @@ define_list_builder_accessors! {
///
/// Finally, you can get fine-grained control over the members of a a
/// TorClientConfig using [`TorClientConfigBuilder`].
///
/// # ⚠ Stability Warning ⚠
///
/// The design of this structure, and of the configuration system for
/// Arti, is likely to change significantly before the release of Arti
/// 1.0.0. The layout of options within this structure is also likely
/// to change. For more information see ticket [#285].
///
/// [#285]: https://gitlab.torproject.org/tpo/core/arti/-/issues/285
#[derive(Clone, Builder, Debug, Eq, PartialEq, AsRef)]
#[builder(build_fn(error = "ConfigBuildError"))]
#[builder(derive(Serialize, Deserialize, Debug))]

8
crates/tor-config/README.md
View File

@ -50,12 +50,4 @@ See the
[`tor_config::load` module-level documentation](load).
for an example.
## ⚠ Stability Warning ⚠
The design of this crate, and of the configuration system for
Arti, is likely to change significantly before the release of Arti
1.0.0. For more information see ticket [#285].
[#285]: https://gitlab.torproject.org/tpo/core/arti/-/issues/285
License: MIT OR Apache-2.0