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

Document the printing features in the user documentation #4657

Closed
SoongNoonien opened this issue Feb 27, 2025 · 3 comments · Fixed by #4731
Closed

Document the printing features in the user documentation #4657

SoongNoonien opened this issue Feb 27, 2025 · 3 comments · Fixed by #4731
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request printing

Comments

@SoongNoonien
Copy link
Member

Is your feature request related to a problem? Please describe.
From a users perspective it is currently not so clear which features regarding the output of data structures are provided by OSCAR. Specifically I think about the unicode stuff. Right now a new user will probably never discover the unicode printing because the only place one can read about it in the docs is inside the developer section.

Describe the solution you'd like
I'd suggest a new page "Printing" under the section "General" which illustrates the unicode printing and possibly even the latex/html printing.

@SoongNoonien SoongNoonien added the enhancement New feature or request label Feb 27, 2025
@lgoettgens lgoettgens added documentation Improvements or additions to documentation printing labels Feb 27, 2025
@fingolfin
Copy link
Member

So this is about allow_unicode and related functions in AbstractAlgebra, I think.

@fingolfin
Copy link
Member

Also is_unicode_allowed and with_unicode.

and it seems one can use https://github.com/JuliaPackaging/Preferences.jl to also store the preferences in a file -- I think @lgoettgens may have added this and may be able to tell us more about how to use it (or perhaps @emikelsons can figure it out himself)

@lgoettgens
Copy link
Member

and it seems one can use JuliaPackaging/Preferences.jl to also store the preferences in a file -- I think @lgoettgens may have added this and may be able to tell us more about how to use it (or perhaps @emikelsons can figure it out himself)

allow_unicode(::Bool) uses Preferences.jl by default (unless setting temporary=true) to persist the setting across sessions. This is explained in its docstring.
@emikelsons if you have any questions concerning docstrings or things maybe missing from there, just ping me.

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 enhancement New feature or request printing
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants