diff options
author | Chris Wailes <chriswailes@google.com> | 2023-02-13 18:36:57 +0000 |
---|---|---|
committer | Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com> | 2023-02-13 18:36:57 +0000 |
commit | 088f865714b6ce2bf35346256f75055d696c261d (patch) | |
tree | 8b043177f6f25fa8b3e7850cc3be58708648c4b8 | |
parent | 726f6be4c7bc9bc8e2884536079d2fb049b9020d (diff) | |
parent | ceea17e41b75f2f7e127424524aa11d110e13089 (diff) | |
download | base64-088f865714b6ce2bf35346256f75055d696c261d.tar.gz |
Fix an error in the documentation strings am: ee071cee30 am: f68d1b763b am: ceea17e41b
Original change: https://android-review.googlesource.com/c/platform/external/rust/crates/base64/+/2431095
Change-Id: I41c48acc15e71ac74e40daf8747d2cb908f2aaa0
Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
-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 /// |