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

ENH: Add note about lack of cleaning methods for data indices #140

Open
rstoneback opened this issue Feb 8, 2024 · 0 comments
Open

ENH: Add note about lack of cleaning methods for data indices #140

rstoneback opened this issue Feb 8, 2024 · 0 comments
Labels
enhancement New feature or request
Milestone

Comments

@rstoneback
Copy link
Collaborator

Description

Add a note or warning to top-level docstring for space weather indices that do not have a cleaning method so that it looks nicely formatted and attention grabbing in documentation. In packages like pysatNASA there is a warning for instruments without cleaning. An index is a more processed dataset than an instrument thus a warning may not be appropriate. Nevertheless, users need guidance somewhere that there is no cleaning.

Potential impact

  • Provides clarity for the user

Potential solution(s)

Add a note or warning to top-level docstring for space weather indices that do not have a cleaning method

Alternatives

  • Leave as is.
  • Add a warning like with pysatNASA. In the log, every load call will have an entry.

Additional context

@rstoneback rstoneback added the enhancement New feature or request label Feb 8, 2024
@aburrell aburrell added this to the 0.2.0 milestone Feb 15, 2024
@aburrell aburrell modified the milestones: 0.2.0, 1.0.0 Aug 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants