caisin/typst
1
0
Fork 0
mirror of https://github.com/typst/typst synced 2025-06-29 00:32:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

Clarify how ident is used in PDF export

Browse Source
This commit is contained in:
Laurenz 2023-10-29 11:22:06 +01:00
parent 500468fd05
commit 987e97cc2c
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
crates/typst/src/export/pdf/mod.rs
View File

@ -39,14 +39,15 @@ use extg::ExtGState;
/// Returns the raw bytes making up the PDF file. /// Returns the raw bytes making up the PDF file.
/// ///
/// The `ident` parameter shall be a string that uniquely and stably identifies /// The `ident` parameter shall be a string that uniquely and stably identifies
/// the document. It is used to write a PDF file identifier. It should not /// the document. It should not change between compilations of the same
/// change between compilations of the same document. If it is `None`, a hash of /// document. Its hash will be used to create a PDF document identifier (the
/// the document is used instead (which means that it _will_ change across /// identifier itself is not leaked). If `ident` is `None`, a hash of the
/// document is used instead (which means that it _will_ change across
/// compilations). /// compilations).
/// ///
/// The `timestamp`, if given, is expected to be the creation date of the /// The `timestamp`, if given, is expected to be the creation date of the
/// document as a UTC datetime. It will be used as the PDFs creation date unless /// document as a UTC datetime. It will only be used if `set document(date: ..)`
/// another date is given through `set document(date: ..)`. /// is `auto`.
#[tracing::instrument(skip_all)] #[tracing::instrument(skip_all)]
pub fn pdf( pub fn pdf(
document: &Document, document: &Document,