Cargo Features

[dependencies]
speak = { version = "0.1.12", default-features = false, features = ["fancy_docs", "easy_panic", "debug"] }
default = debug, fancy_docs

debug is required (being that Speak is in development)

fancy_docs default

Fancy Docs

Fancy docs is the feature that adds some fancy documentation to the Speak crate. It is not required, but it is recommended. It adds things like **graphs** or **Latex equations** to the more complex documentation.

Dependencies used

  • Aquamarine (0.1.1)

Enables aquamarine ^0.1.1

easy_panic

Easy Panic

***The use of this feature is recommended to pair the use of the `debug` feature, but not obligatory.*** This feature is a very optional and easy to understand feature, it will panic if the program haves an error. With this feature disabled the program will return nothing meaningful, but it will not panic, with this feature enabled the program will panic if it has an error.

What is an error?

An error is a situation that the utils library can't handle, like encouraging an out-of-bounds index. In the main functions (run and learn) there isn't posible errors, so, if you're going to manually check the index you're using (Not recommended), you can disable this feature.

Dependencies

No dependencies used.

Enables colored

debug default

Debug

Enables simple debug messages.

Dependencies

  • colored (2.0.0)

Enables colored