You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The mdbook-forc-documenter plugin for mdbook is not compatible with the output of the newest version of clap, which it parses in a simple manner to generate documentation pages for forc commands and plugins.
The proposal is to also add a check to mdbook-forc-documenter to ensure that the version of clap didn't change. In case of a change, we would manually check the validity of the output and adapt the mdbook-forc-documenter's unit tests. Note that the documenter has unit tests, but they are all testing proper text transformations during rendering, which assumes that the input is in a certain format, which can potentially change when the clap version changes.
All the tools have the name "Forc"
E.g.:
Subcommands are not recognized and generated as a single text
E.g.:
Short text for examples is rendered as Heading 1
E.g.:
The text was updated successfully, but these errors were encountered:
The
mdbook-forc-documenter
plugin formdbook
is not compatible with the output of the newest version ofclap
, which it parses in a simple manner to generate documentation pages forforc
commands and plugins.Below are some of the issues. All of them can be seen on the official documentation page of the current Sway version:
https://fuellabs.github.io/sway/v0.66.5/book/
The proposal is to also add a check to
mdbook-forc-documenter
to ensure that the version ofclap
didn't change. In case of a change, we would manually check the validity of the output and adapt themdbook-forc-documenter
's unit tests. Note that the documenter has unit tests, but they are all testing proper text transformations during rendering, which assumes that the input is in a certain format, which can potentially change when theclap
version changes.All the tools have the name "Forc"
E.g.:
Subcommands are not recognized and generated as a single text
E.g.:
Short text for examples is rendered as Heading 1
E.g.:
The text was updated successfully, but these errors were encountered: