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 Use Existing Resolutions Option #260

Open
muhanadz opened this issue Oct 8, 2024 · 1 comment
Open

Document Use Existing Resolutions Option #260

muhanadz opened this issue Oct 8, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@muhanadz
Copy link
Member

muhanadz commented Oct 8, 2024

Recent discussions pointed out --use-existing-resolutions is not documented in the README. In the .mrxs format, the README states:

the full-resolution image, but will not read the original pyramid for this format. Datasets in this format include

This implies there is no way around this behaviour, which is not the case if using --use-existing-resolutions.

Opening an issue to suggest documenting the --use-existing-resolutions as option in the README. It's just a question of where and how to reference it where needed.

@muhanadz muhanadz added the documentation Improvements or additions to documentation label Oct 8, 2024
@melissalinkert
Copy link
Member

👍 to documenting --use-existing-resolutions, maybe at the end of the Usage section in the README.

Keep in mind that while that option may have an effect on .mrxs data, we really don't recommend using it. The existing pyramid is generally not usable, and this is part of the reason why .mrxs data is only supported by conversion.

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