Skip to content

Commit

Permalink
Doc tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
TCA166 committed Jan 31, 2025
1 parent 86f98ff commit f764b50
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ check: src/*.rs src/structures/*.rs

doc: src/*.rs src/structures/*.rs
@echo "Building documentation..."
cargo doc --document-private-items --bin ck3_history_extractor
cargo doc --document-private-items --no-deps --bin ck3_history_extractor

dependencies:
@echo "Installing dependencies..."
Expand Down
2 changes: 1 addition & 1 deletion src/display/renderer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ fn create_dir_maybe<P: AsRef<Path>>(name: P) {

/// A struct that renders objects into html pages.
/// It holds a reference to the [Environment] that is used to render the templates, tracks which objects have been rendered and holds the root path.
/// Additionally holds references to the [GameMap] and [Grapher] objects, should they exist of course.
/// Additionally holds references to the GameMap and [Grapher] objects, should they exist of course.
/// It is meant to be used as a worker object that renders objects into html pages.
pub struct Renderer<'a> {
/// The [minijinja] environment object that is used to render the templates.
Expand Down
7 changes: 4 additions & 3 deletions src/parser/mod.rs
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
/// A submodule that provides [jomini] abstractions
mod types;

/// A submodule that provides the intermediate parsing interface for the save file.
/// The parser uses [GameObject](crate::parser::game_object::GameObject) to store the parsed data and structures in [structures](crate::structures) are initialized from these objects.
mod game_object;
use std::{
error,
fmt::{self, Debug, Display},
num::ParseIntError,
};

/// A submodule that provides the intermediate parsing interface for the save file.
/// The parser uses [GameObject](crate::parser::game_object::SaveFileObject) to store the parsed data and structures in [structures](crate::structures) are initialized from these objects.
mod game_object;

pub use game_object::{
ConversionError, GameId, GameObjectCollection, GameObjectMap, GameObjectMapping, GameString,
KeyError, SaveFileObject, SaveFileValue, SaveObjectError,
Expand Down
2 changes: 1 addition & 1 deletion src/parser/section_reader.rs
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ pub fn yield_section<'tape, 'data: 'tape>(
}
BinaryToken::Close => {
return Some(Err(SectionReaderError::UnexpectedToken(
binary.position(),
tape.position(),
BinaryToken::Close.into(),
"unexpected close token",
)))
Expand Down
1 change: 0 additions & 1 deletion src/parser/types.rs
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,6 @@ impl<'a> Tape<'a> {
Ok(())
}

#[allow(dead_code)]
pub fn position(&self) -> usize {
match self {
Self::Text(tape) => tape.position(),
Expand Down

0 comments on commit f764b50

Please sign in to comment.