Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Failure with space in filenames #168

Closed
blegat opened this issue Sep 1, 2021 · 1 comment
Closed

Failure with space in filenames #168

blegat opened this issue Sep 1, 2021 · 1 comment

Comments

@blegat
Copy link

blegat commented Sep 1, 2021

I had a examples with a file named "Bound on Global Extremum.jl".
It worked before but with the lastest version of Literate and Documenter, it fails with

ERROR: LoadError: invalid '@example' syntax: @example Bound on Global Extremum

See https://github.com/jump-dev/SumOfSquares.jl/pull/201/checks?check_run_id=3464443765#step:5:116
Maybe Literate should replace spaced by underscores when generating the label to be used with @example so that there is no space in the name.

@fredrikekre
Copy link
Owner

I don't think anything in Literate has changed here, so probably a Documenter change. Probably before the name of the example in Documenter would be just "Bound" but now seems like there is some extra restrictions.

Maybe Literate should replace spaced by underscores when generating the label to be used with @example so that there is no space in the name.

Sure, seems like a good idea.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants