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

[skip ci] fix and expand file_device and file_extension documentation #721

Merged
merged 1 commit into from
Aug 23, 2024

Conversation

mathren
Copy link
Contributor

@mathren mathren commented Aug 23, 2024

Regarding this mailing list request: https://lists.mesastar.org/pipermail/mesa-users/2024-August/015307.html

Documentation was incorrectly suggesting pdf files can be produced directly from pgplots and the option to produce ps and eps were instead not documented.

@mathren mathren added the documentation Improvements or additions to documentation label Aug 23, 2024
@mathren mathren assigned mathren and rhdtownsend and unassigned mathren Aug 23, 2024
@pmocz pmocz merged commit e29ed74 into main Aug 23, 2024
@warrickball
Copy link
Contributor

I just had a quick play around with this myself and I'm not sure it's clear that file extension is just what is literally used in the filename, has no bearing on the format and is not limited to a string set of options. So although users probably want to use an extension associated with the relevant device, it's not required.

If we only intend to write files with the relevant file extensions, we should remove the file_extension option and write code that selects the extension based on file_device. From what little I know about PGPLOT, it theoretically supports other options for file_device but I can't see us (or our users) wanting anything but ps, vcps or png. (I briefly tried to find a list of supported devices but didn't manage to find one that mentioned png, which is clearly supported.)

@pmocz
Copy link
Member

pmocz commented Aug 25, 2024

I just had a quick play around with this myself and I'm not sure it's clear that file extension is just what is literally used in the filename, has no bearing on the format and is not limited to a string set of options. So although users probably want to use an extension associated with the relevant device, it's not required.

If we only intend to write files with the relevant file extensions, we should remove the file_extension option and write code that selects the extension based on file_device. From what little I know about PGPLOT, it theoretically supports other options for file_device but I can't see us (or our users) wanting anything but ps, vcps or png. (I briefly tried to find a list of supported devices but didn't manage to find one that mentioned png, which is clearly supported.)

Great idea! Removing the file_extension option will minimize confusion. I created a PR here: #722

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

Successfully merging this pull request may close these issues.

4 participants