Expand description
§Prose analyzer module
This is where we keep functions and interfaces necessary to execute ACORN’s automated editorial style guide as well as content readability analyzer.
Modules§
- readability
- Readability utilities
- vale
- Vale interface
Structs§
- Check
- Data structure for holding the result of a schema validation check
- Check
Builder - Use builder syntax to set the inputs and finish with
build().
Enums§
- Check
Category - Various check categories available for validating research activity data
- Error
Kind - Error kind
Traits§
- IntoRow
- Trait for converting to a (Polars) row
- Static
Analyzer - Trait for static analyzers (e.g. Vale)
- Static
Analyzer Config - Trait for static analyzer configuration (e.g. .vale.ini)
Functions§
- checks_
to_ dataframe - Convert vector of
Checkvalues to a Polars [DataFrame] - convert_
lychee_ response - Convert Lychee response to
Check - link_
check - Perform link check on given URL using Lychee
- pretty_
print - Prints
textto stdout using syntax highlighting for the specifiedsyntax. - summary
- Create summary data table from given issues
- to_
dataframe - Convert vector of values of a given type to a Polars DataFrame