diff options
| author | Wiktor Kwapisiewicz <wiktor@metacode.biz> | 2020-07-30 10:08:01 +0200 |
|---|---|---|
| committer | Wiktor Kwapisiewicz <wiktor@metacode.biz> | 2020-08-18 10:21:06 +0200 |
| commit | 53cf8882e1fa4569f9a87bd79e7d5bc3a94879d2 (patch) | |
| tree | 143ddd0de250690fc7b71c242ce758ad8564ede6 | |
| parent | e80c467375501ed1f3e465c2e1e4860122dad7b4 (diff) | |
openpgp: Correct documentation for Writer::finalize()
Since 468302d5 the `finalize` function is not called when the writer is
dropped.
This change adjusts the doc comment.
| -rw-r--r-- | openpgp/src/armor.rs | 4 |
1 files changed, 1 insertions, 3 deletions
diff --git a/openpgp/src/armor.rs b/openpgp/src/armor.rs index cb356745..8051e9f3 100644 --- a/openpgp/src/armor.rs +++ b/openpgp/src/armor.rs @@ -263,9 +263,7 @@ impl<W: Write> Writer<W> { /// Writes the footer. /// - /// No more data can be written after this call. If this is not - /// called explicitly, the footer is written once the writer is - /// dropped. + /// This function needs to be called explicitly before the writer is dropped. pub fn finalize(mut self) -> Result<W> { if ! self.dirty { // No data was written to us, don't emit anything. |