Skip to content

Commit 2a037f6

Browse files
committed
chore: resolve warnings
1 parent 1ce4ea6 commit 2a037f6

File tree

3 files changed

+22
-4
lines changed

3 files changed

+22
-4
lines changed

module/move/wca/src/ca/formatter.rs

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,26 @@ mod private
55
use iter_tools::Itertools;
66
use ca::aggregator::Order;
77

8-
/// -
8+
/// Enum representing the format options for generating help content.
9+
///
10+
/// `HelpFormat` defines the output format of help content, enabling the choice
11+
/// between different styles, such as `Markdown` for structured text, or other
12+
/// custom formats.
913
#[ derive( Debug, Clone, PartialEq ) ]
1014
pub enum HelpFormat
1115
{
16+
/// Generates help content in Markdown format, suitable for environments
17+
/// that support Markdown rendering (e.g., documentation platforms, text editors).
1218
Markdown,
19+
/// Represents an alternative format, customizable for different needs.
1320
Another,
1421
}
1522

23+
/// Generates Markdown-formatted help content based on a dictionary of terms and a specified order.
24+
///
25+
/// The `md_generator` function takes a reference to a `Dictionary` and an `Order` to produce
26+
/// a help document in Markdown format. This function is useful for generating structured,
27+
/// readable help documentation suitable for Markdown-compatible platforms.
1628
pub fn md_generator( grammar : &Dictionary, order: Order ) -> String
1729
{
1830
let text = grammar.commands()

module/move/wca/src/ca/help.rs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,16 @@ mod private
2121

2222
// qqq : for Bohdan : it should transparent mechanist which patch list of commands, not a stand-alone mechanism
2323

24+
/// Enum `LevelOfDetail` specifies the granularity of detail for rendering or processing:
2425
#[ derive( Debug, Default, Copy, Clone, PartialEq, Eq ) ]
2526
pub enum LevelOfDetail
2627
{
28+
/// No detail (default).
2729
#[ default ]
2830
None,
31+
/// Basic level of detail.
2932
Simple,
33+
/// High level of detail.
3034
Detailed,
3135
}
3236

@@ -64,6 +68,11 @@ mod private
6468
}
6569

6670
// qqq : for Barsik : make possible to change properties order
71+
/// Generates help content as a formatted string based on a given dictionary and options.
72+
///
73+
/// This function takes a `Dictionary` of terms or commands and a `HelpGeneratorOptions`
74+
/// struct to customize the help output, generating a user-friendly help message
75+
/// or guide in `String` format.
6776
pub fn generate_help_content( dictionary : &Dictionary, o : HelpGeneratorOptions< '_ > ) -> String
6877
{
6978
struct Row

module/move/wca/src/lib.rs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44
#![ doc = include_str!( concat!( env!( "CARGO_MANIFEST_DIR" ), "/", "Readme.md" ) ) ]
55
#![ doc = include_str!( concat!( env!( "CARGO_MANIFEST_DIR" ), "/", "doc/", "wca.md" ) ) ]
66

7-
#![ allow( where_clauses_object_safety ) ] // https://github.com/chris-morgan/anymap/issues/31
8-
// qqq : xxx : is it neccessary?
9-
107
use mod_interface::mod_interface;
118

129
pub mod ca;

0 commit comments

Comments
 (0)