From 17eb14aa48ce36619bc6f8eedc897446304122ca Mon Sep 17 00:00:00 2001 From: Valery Antopol Date: Tue, 28 Sep 2021 15:44:12 +0300 Subject: [PATCH] use doc(hidden) on internal api (#62) --- Cargo.lock | 20 ++++++++++---------- crates/main/Cargo.toml | 4 ++-- crates/main/src/lib.rs | 2 +- crates/marine-macro-impl/Cargo.toml | 2 +- crates/marine-macro-impl/src/lib.rs | 2 +- crates/marine-macro/Cargo.toml | 4 ++-- crates/marine-macro/src/lib.rs | 2 +- crates/timestamp-macro/Cargo.toml | 2 +- sdk/Cargo.toml | 8 ++++---- sdk/src/lib.rs | 3 ++- 10 files changed, 25 insertions(+), 24 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 8fdb05a..db8312a 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -756,9 +756,9 @@ dependencies = [ [[package]] name = "marine-macro" -version = "0.6.12" +version = "0.6.13" dependencies = [ - "marine-macro-impl 0.6.12", + "marine-macro-impl 0.6.13", ] [[package]] @@ -777,7 +777,7 @@ dependencies = [ [[package]] name = "marine-macro-impl" -version = "0.6.12" +version = "0.6.13" dependencies = [ "marine-macro-testing-utils", "pretty_assertions", @@ -846,11 +846,11 @@ dependencies = [ [[package]] name = "marine-rs-sdk" -version = "0.6.12" +version = "0.6.13" dependencies = [ - "marine-macro 0.6.12", - "marine-rs-sdk-main 0.6.12", - "marine-timestamp-macro 0.6.12", + "marine-macro 0.6.13", + "marine-rs-sdk-main 0.6.13", + "marine-timestamp-macro 0.6.13", "serde", "trybuild", ] @@ -868,11 +868,11 @@ dependencies = [ [[package]] name = "marine-rs-sdk-main" -version = "0.6.12" +version = "0.6.13" dependencies = [ "lazy_static", "log", - "marine-macro 0.6.12", + "marine-macro 0.6.13", "serde", "simple_logger", ] @@ -959,7 +959,7 @@ dependencies = [ [[package]] name = "marine-timestamp-macro" -version = "0.6.12" +version = "0.6.13" dependencies = [ "chrono", "quote", diff --git a/crates/main/Cargo.toml b/crates/main/Cargo.toml index 797913a..8478219 100644 --- a/crates/main/Cargo.toml +++ b/crates/main/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "marine-rs-sdk-main" -version = "0.6.12" # remember to update html_root_url +version = "0.6.13" # remember to update html_root_url edition = "2018" description = "Contains logger, allocators and several other modules for marine-rs-sdk" documentation = "https://docs.rs/marine-rs-sdk-main" @@ -19,7 +19,7 @@ crate-type = ["rlib"] doctest = false [dependencies] -marine-macro = { path = "../marine-macro", version = "=0.6.12" } +marine-macro = { path = "../marine-macro", version = "=0.6.13" } log = { version = "0.4.8", features = ["std"] } serde = "1.0.118" diff --git a/crates/main/src/lib.rs b/crates/main/src/lib.rs index cc03810..8dba853 100644 --- a/crates/main/src/lib.rs +++ b/crates/main/src/lib.rs @@ -19,7 +19,7 @@ #![allow(clippy::missing_safety_doc)] #![allow(clippy::needless_doctest_main)] -#![doc(html_root_url = "https://docs.rs/marine-rs-sdk-main/0.6.12")] +#![doc(html_root_url = "https://docs.rs/marine-rs-sdk-main/0.6.13")] #![deny( dead_code, nonstandard_style, diff --git a/crates/marine-macro-impl/Cargo.toml b/crates/marine-macro-impl/Cargo.toml index 76a199c..43d3c75 100644 --- a/crates/marine-macro-impl/Cargo.toml +++ b/crates/marine-macro-impl/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "marine-macro-impl" -version = "0.6.12" # remember to update html_root_url +version = "0.6.13" # remember to update html_root_url edition = "2018" description = "Implementation of the `#[marine]` macro" documentation = "https://docs.rs/fluence/marine-macro-impl" diff --git a/crates/marine-macro-impl/src/lib.rs b/crates/marine-macro-impl/src/lib.rs index 96ecf63..f87398d 100644 --- a/crates/marine-macro-impl/src/lib.rs +++ b/crates/marine-macro-impl/src/lib.rs @@ -14,7 +14,7 @@ * limitations under the License. */ -#![doc(html_root_url = "https://docs.rs/marine-macro-impl/0.6.12")] +#![doc(html_root_url = "https://docs.rs/marine-macro-impl/0.6.13")] #![deny( dead_code, nonstandard_style, diff --git a/crates/marine-macro/Cargo.toml b/crates/marine-macro/Cargo.toml index 9d8bad5..b9ad671 100644 --- a/crates/marine-macro/Cargo.toml +++ b/crates/marine-macro/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "marine-macro" -version = "0.6.12" # remember to update html_root_url +version = "0.6.13" # remember to update html_root_url edition = "2018" description = "Definition of the `#[marine]` macro" documentation = "https://docs.rs/fluence/marine-macro" @@ -18,4 +18,4 @@ proc-macro = true doctest = false [dependencies] -marine-macro-impl = { path = "../marine-macro-impl", version = "=0.6.12" } +marine-macro-impl = { path = "../marine-macro-impl", version = "=0.6.13" } diff --git a/crates/marine-macro/src/lib.rs b/crates/marine-macro/src/lib.rs index 09e9ea3..eb2e6f6 100644 --- a/crates/marine-macro/src/lib.rs +++ b/crates/marine-macro/src/lib.rs @@ -50,7 +50,7 @@ //! //! ``` -#![doc(html_root_url = "https://docs.rs/marine-macro/0.6.12")] +#![doc(html_root_url = "https://docs.rs/marine-macro/0.6.13")] #![deny( dead_code, nonstandard_style, diff --git a/crates/timestamp-macro/Cargo.toml b/crates/timestamp-macro/Cargo.toml index 182e8a1..7191355 100644 --- a/crates/timestamp-macro/Cargo.toml +++ b/crates/timestamp-macro/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "marine-timestamp-macro" -version = "0.6.12" # remember to update html_root_url +version = "0.6.13" # remember to update html_root_url edition = "2018" description = "Definition of the `#[build_timestamp]` macro" documentation = "https://docs.rs/fluence/marine-timestamp-macro" diff --git a/sdk/Cargo.toml b/sdk/Cargo.toml index b4c1588..493dc65 100644 --- a/sdk/Cargo.toml +++ b/sdk/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "marine-rs-sdk" -version = "0.6.12" # remember to update html_root_url +version = "0.6.13" # remember to update html_root_url description = "Fluence backend SDK for developing backend applications for the Fluence network" documentation = "https://docs.rs/fluence" repository = "https://github.com/fluencelabs/marine-rs-sdk" @@ -18,9 +18,9 @@ path = "src/lib.rs" doctest = false [dependencies] -marine-macro = { path = "../crates/marine-macro", version = "=0.6.12" } -marine-rs-sdk-main = { path = "../crates/main", version = "=0.6.12" } -marine-timestamp-macro = { path = "../crates/timestamp-macro", version = "=0.6.12" } +marine-macro = { path = "../crates/marine-macro", version = "=0.6.13" } +marine-rs-sdk-main = { path = "../crates/main", version = "=0.6.13" } +marine-timestamp-macro = { path = "../crates/timestamp-macro", version = "=0.6.13" } serde = { version = "1.0.118", features = ["derive"]} diff --git a/sdk/src/lib.rs b/sdk/src/lib.rs index 87c0101..a0e8622 100644 --- a/sdk/src/lib.rs +++ b/sdk/src/lib.rs @@ -55,7 +55,7 @@ //! pub fn curl_get(url: String) -> String; //! } //! ``` -#![doc(html_root_url = "https://docs.rs/sdk/0.6.12")] +#![doc(html_root_url = "https://docs.rs/sdk/0.6.13")] #![deny( dead_code, nonstandard_style, @@ -94,6 +94,7 @@ pub use marine_rs_sdk_main::module_manifest; /// These API functions are intended for internal usage in generated code. /// Normally, you shouldn't use them. +#[doc(hidden)] pub mod internal { pub use marine_rs_sdk_main::get_result_ptr; pub use marine_rs_sdk_main::get_result_size;