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

Improve documentation about headers #1101

Open
kelle opened this issue Nov 15, 2023 · 0 comments
Open

Improve documentation about headers #1101

kelle opened this issue Nov 15, 2023 · 0 comments
Labels

Comments

@kelle
Copy link
Member

kelle commented Nov 15, 2023

Based on discussion in #617 , there is a need for more documentation about headers.

I propose a Header section be added to Working with Spectrum1Ds.

Something like:

Headers

There is currently not universally standard behavior for the handling of header information. In particular, header data is not guaranteed to be preserved or updated. Users should take care with monitoring any important header keywords.

A common practice is to store the primary header in meta['header'] rather than in meta directly.

[a couple examples..]

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

No branches or pull requests

1 participant