Skip to content

Commit

Permalink
Update documentation of fj
Browse files Browse the repository at this point in the history
  • Loading branch information
hannobraun committed Jun 19, 2023
1 parent 0cf9f07 commit 8232b3d
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions crates/fj/src/args.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@ use fj_core::algorithms::approx::{InvalidTolerance, Tolerance};
use fj_math::Scalar;

/// Standardized CLI for Fornjot models
///
/// This is completely optional, as models are just Rust code and don't need any
/// kind of CLI interface. It is useful, however, to provide a standardized
/// interface for viewing and exporting models, and is used for Fornjot's
/// example models and the testing infrastructure they are part of.
///
/// You might not want to use this struct directly. [`handle_model`] Provides a
/// more high-level and convenient interface.
///
/// [`handle_model`]: crate::handle_model()
#[derive(clap::Parser)]
pub struct Args {
/// Export model to this path
Expand Down

0 comments on commit 8232b3d

Please sign in to comment.