diff options
| author | Chris Wailes <chriswailes@google.com> | 2023-02-09 23:15:26 -0800 |
|---|---|---|
| committer | Mike Yu <yumike@google.com> | 2023-02-16 12:18:42 +0000 |
| commit | b79c770284ab47f096b6d706dbb2faa267380daf (patch) | |
| tree | 8b043177f6f25fa8b3e7850cc3be58708648c4b8 | |
| parent | d5b692270d805597d96ceaa047d7792f00e74942 (diff) | |
| download | base64-b79c770284ab47f096b6d706dbb2faa267380daf.tar.gz | |
Fix an error in the documentation strings
This file explicitly turns on this warning meaning that it can't be
overridden by command line lint arguments. The rustdoc from version
1.66.1 will fail without this patch.
Test: m rustdoc
Bug: 263153841
Change-Id: Idcf3779cbd46300691232302bba10c46143a2dbc
(cherry picked from commit ee071cee30d09d169c4bd88d8bd71fc104b57071)
Merged-In: Idcf3779cbd46300691232302bba10c46143a2dbc
| -rw-r--r-- | patches/doc-string-fix.patch | 41 | ||||
| -rw-r--r-- | src/decode.rs | 4 |
2 files changed, 43 insertions, 2 deletions
diff --git a/patches/doc-string-fix.patch b/patches/doc-string-fix.patch new file mode 100644 index 0000000..15370bf --- /dev/null +++ b/patches/doc-string-fix.patch @@ -0,0 +1,41 @@ +From 27fc4ecc69aab7b31e23aefbeed10b252b176d5a Mon Sep 17 00:00:00 2001 +From: Chris Wailes <chriswailes@google.com> +Date: Thu, 9 Feb 2023 23:15:26 -0800 +Subject: [PATCH] Fix an error in the documentation strings + +This file explicitly turns on this warning meaning that it can't be +overridden by command line lint arguments. The rustdoc from version +1.66.1 will fail without this patch. + +Test: m rustdoc +Bug: 263153841 +Change-Id: Idcf3779cbd46300691232302bba10c46143a2dbc +--- + src/decode.rs | 4 ++-- + 1 file changed, 2 insertions(+), 2 deletions(-) + +diff --git a/src/decode.rs b/src/decode.rs +index e349240..3f627c7 100644 +--- a/src/decode.rs ++++ b/src/decode.rs +@@ -71,7 +71,7 @@ impl error::Error for DecodeError { + } + + ///Decode from string reference as octets. +-///Returns a Result containing a Vec<u8>. ++///Returns a Result containing a `Vec<u8>`. + ///Convenience `decode_config(input, base64::STANDARD);`. + /// + ///# Example +@@ -90,7 +90,7 @@ pub fn decode<T: AsRef<[u8]>>(input: T) -> Result<Vec<u8>, DecodeError> { + } + + ///Decode from string reference as octets. +-///Returns a Result containing a Vec<u8>. ++///Returns a Result containing a `Vec<u8>`. + /// + ///# Example + /// +-- +2.39.1.581.gbfd45094c4-goog + diff --git a/src/decode.rs b/src/decode.rs index e349240..3f627c7 100644 --- a/src/decode.rs +++ b/src/decode.rs @@ -71,7 +71,7 @@ impl error::Error for DecodeError { } ///Decode from string reference as octets. -///Returns a Result containing a Vec<u8>. +///Returns a Result containing a `Vec<u8>`. ///Convenience `decode_config(input, base64::STANDARD);`. /// ///# Example @@ -90,7 +90,7 @@ pub fn decode<T: AsRef<[u8]>>(input: T) -> Result<Vec<u8>, DecodeError> { } ///Decode from string reference as octets. -///Returns a Result containing a Vec<u8>. +///Returns a Result containing a `Vec<u8>`. /// ///# Example /// |