Skip to content

Commit

Permalink
Fix doc warnings, add doc to CI. (#151)
Browse files Browse the repository at this point in the history
  • Loading branch information
tirix authored Nov 28, 2023
1 parent 8ea682e commit 234b78d
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 8 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/verify.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ jobs:
run: cargo clippy --all-targets --all-features -- -D warnings
- name: Format
run: cargo fmt -- --check
- name: Docs
run: cargo doc --lib --no-deps
- name: Verify official set.mm
run: |
curl -s -G https://raw.githubusercontent.com/metamath/set.mm/develop/set.mm > set.mm
Expand Down
8 changes: 4 additions & 4 deletions metamath-rs/src/comment_parser.rs
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,12 @@ pub enum CommentItem {
/// before and after the element), but corresponds roughly to a `<p>` tag in HTML.
LineBreak(usize),
/// Start math mode, indicated by a backtick character. The usize points to the character.
/// Between [`StartMathMode`] and [`EndMathMode`],
/// there will be no comment items other than [`MathToken`].
/// Between [`CommentItem::StartMathMode`] and [`CommentItem::EndMathMode`],
/// there will be no comment items other than [`CommentItem::MathToken`].
StartMathMode(usize),
/// End math mode, indicated by a backtick character. The usize points to the character.
/// Between [`StartMathMode`] and [`EndMathMode`],
/// there will be no comment items other than [`MathToken`].
/// Between [`CommentItem::StartMathMode`] and [`CommentItem::EndMathMode`],
/// there will be no comment items other than [`CommentItem::MathToken`].
EndMathMode(usize),
/// A single math token. After unescaping this should correspond to a `$c` or `$v` statement
/// in the database.
Expand Down
2 changes: 1 addition & 1 deletion metamath-rs/src/database.rs
Original file line number Diff line number Diff line change
Expand Up @@ -642,7 +642,7 @@ impl Database {
}

/// Returns axiom usage verification information for the database.
/// Returns `None` if [`Database::usage_pass`] was not previously called.
/// Returns `None` if [`Database::verify_usage_pass`] was not previously called.
///
/// This is an optimized verifier which returns no useful information other
/// than error diagnostics. It does not save any parsed proof data.
Expand Down
6 changes: 3 additions & 3 deletions metamath-rs/src/verify_markup.rs
Original file line number Diff line number Diff line change
Expand Up @@ -522,9 +522,9 @@ pub struct Bibliography(HashSet<Box<[u8]>>);
/// A pair of bibliography files. This is used to support `set.mm`, which
/// contains two separate-ish databases inside one metamath file. Bibliography
/// references in the first part of the file refer to the
/// [`TypesettingData::html_bibliography`],
/// while references after the [`TypesettingData::ext_html_label`] go to the
/// [`TypesettingData::ext_html_bibliography`].
/// [`html_bibliography`][crate::typesetting::TypesettingData::html_bibliography],
/// while references after the [`ext_html_label`][crate::typesetting::TypesettingData::ext_html_label] go to the
/// [`ext_html_bibliography`][crate::typesetting::TypesettingData::ext_html_bibliography].
#[derive(Debug)]
pub struct Bibliography2 {
/// The main bibliography file.
Expand Down

0 comments on commit 234b78d

Please sign in to comment.