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

Examples in documentation may not compile. #12

Open
1 task done
brittAnderson opened this issue Jul 5, 2024 · 0 comments
Open
1 task done

Examples in documentation may not compile. #12

brittAnderson opened this issue Jul 5, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@brittAnderson
Copy link

Is there an existing issue for this?

  • I have searched the existing issues

Original goal

I wanted to try the library, and so I cut and pasted the example from page 1 of the documentation into a latex file and it failed to compile.

Current impasse

See above.

Lacking resources

No response

Additional context

The problem is that while one might assume that a user could guess the need for the the tikz package, the need to also \usetikzlibrary{calc,positioning} wasn't immediately obvious since they were not mentioned. Might recommend including the list of additional tikz libraries needed for the basic functionality indicated in the documentation examples.

@brittAnderson brittAnderson added the documentation Improvements or additions to documentation label Jul 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants