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

Update documentation variable names #368

Merged
merged 2 commits into from
Mar 26, 2024

Conversation

greglucas
Copy link
Collaborator

Change Summary

Overview

This removes the hyphen from the variable name as a possibility as discussed on the call with SPDF today. Give some examples of options for other variable parameters. Make these variable names should not must. Remove the instrument name from the variable name prefix.

Additionally, I removed the file naming convention from this page and pointed to our naming conventions page so we only have one source of truth.

@greglucas greglucas added the Repo: Documentation Improvements or additions to documentation label Mar 21, 2024
@greglucas greglucas requested review from a team, bourque, sdhoyt, tech3371, vmartinez-cu, laspsandoval and maxinelasp and removed request for a team March 21, 2024 17:34
Copy link
Collaborator

@bourque bourque left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, and thanks for removing the redundant documentation!

@greglucas greglucas merged commit 6cca171 into IMAP-Science-Operations-Center:dev Mar 26, 2024
17 checks passed
@greglucas greglucas deleted the doc-variable branch March 26, 2024 16:36
laspsandoval pushed a commit to laspsandoval/imap_processing that referenced this pull request Apr 2, 2024
…doc-variable

Update documentation variable names
@bourque
Copy link
Collaborator

bourque commented Apr 2, 2024

@all-contributors Please add @vmartinez-cu for review!

Copy link
Contributor

@bourque

I've put up a pull request to add @vmartinez-cu! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Repo: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants