Skip to content

Commit d57af3f

Browse files
committed
Hide the internal implementation of Encoding in the documentation
The implementation itself (`InternalEncoding`) is already hidden, but the field in the definition of `Encoding` is not. Fixes #75
1 parent 8c8fe8e commit d57af3f

File tree

6 files changed

+21
-10
lines changed

6 files changed

+21
-10
lines changed

bin/Cargo.toml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "data-encoding-bin"
3-
version = "0.3.2"
3+
version = "0.3.3-git"
44
authors = ["Julien Cretin <[email protected]>"]
55
license = "MIT"
66
edition = "2021"
@@ -16,5 +16,5 @@ name = "data-encoding"
1616
path = "src/main.rs"
1717

1818
[dependencies]
19-
data-encoding = { version = "2", path = "../lib" }
19+
data-encoding = { version = "2.4.1-git", path = "../lib" }
2020
getopts = "0.2"

lib/CHANGELOG.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Changelog
22

3+
## 2.4.1-git
4+
5+
### Patch
6+
7+
- Hide the documentation of the `Encoding` implementation (fixes #75)
8+
39
## 2.4.0
410

511
### Minor

lib/Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "data-encoding"
3-
version = "2.4.0"
3+
version = "2.4.1-git"
44
authors = ["Julien Cretin <[email protected]>"]
55
license = "MIT"
66
edition = "2018"

lib/macro/Cargo.toml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "data-encoding-macro"
3-
version = "0.1.13"
3+
version = "0.1.14-git"
44
authors = ["Julien Cretin <[email protected]>"]
55
license = "MIT"
66
edition = "2018"
@@ -14,5 +14,5 @@ description = "Macros for data-encoding"
1414
include = ["Cargo.toml", "LICENSE", "README.md", "src/lib.rs"]
1515

1616
[dependencies]
17-
data-encoding = { version = "2.4", path = "..", default-features = false }
18-
data-encoding-macro-internal = { version = "0.1.11", path = "internal" }
17+
data-encoding = { version = "2.4.1-git", path = "..", default-features = false }
18+
data-encoding-macro-internal = { version = "0.1.12-git", path = "internal" }

lib/macro/internal/Cargo.toml

+8-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "data-encoding-macro-internal"
3-
version = "0.1.11"
3+
version = "0.1.12-git"
44
authors = ["Julien Cretin <[email protected]>"]
55
license = "MIT"
66
edition = "2018"
@@ -14,5 +14,10 @@ include = ["Cargo.toml", "LICENSE", "README.md", "src/lib.rs"]
1414
proc-macro = true
1515

1616
[dependencies]
17-
data-encoding = { version = "2.4", path = "../..", default-features = false, features = ["alloc"] }
18-
syn = { version = "1", default-features = false, features = ["parsing", "proc-macro"] }
17+
data-encoding = { version = "2.4.1-git", path = "../..", default-features = false, features = [
18+
"alloc",
19+
] }
20+
syn = { version = "1", default-features = false, features = [
21+
"parsing",
22+
"proc-macro",
23+
] }

lib/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -871,7 +871,7 @@ pub type InternalEncoding = &'static [u8];
871871
// - width % dec(bit) == 0
872872
// - for all x in separator values[x] is IGNORE
873873
#[derive(Debug, Clone, PartialEq, Eq)]
874-
pub struct Encoding(pub InternalEncoding);
874+
pub struct Encoding(#[doc(hidden)] pub InternalEncoding);
875875

876876
/// How to translate characters when decoding
877877
///

0 commit comments

Comments
 (0)