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.

Sign up for GitHub

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

Jump to bottom

incorrect description for "frequency" coordinates in the API doc #326

Closed
kswang1029 opened this issue Nov 25, 2024 · 2 comments · Fixed by #345
Closed

incorrect description for "frequency" coordinates in the API doc #326

kswang1029 opened this issue Nov 25, 2024 · 2 comments · Fixed by #345
Assignees
@FedeMPouzols
Labels
MSv4 Review

Comments

@kswang1029
Copy link

There are a number of places in the API documentation where the description for frequency coordinates seems incorrect. For example:

Screenshot 2024-11-25 at 13 30 37
@kswang1029
Copy link
Author

Similar issue but in the general description
Screenshot 2024-11-25 at 13 40 57

@FedeMPouzols
Copy link
Collaborator

@kswang1029: thanks for catching this. Yes, the description of frequency in FrequencyArray in the schema is wrong, and this is used for several arrays (flag, weight, vis/spectrum, etc.), and this error is also propagated to FrequencyCalArray. That's simple to fix. And yes, those three quantities have a wrong unit in their general class doc.

@FedeMPouzols FedeMPouzols self-assigned this Dec 5, 2024
FedeMPouzols added a commit that referenced this issue Dec 6, 2024
@FedeMPouzols
fix freq coords description, also time_weather, #326
ab2123a
FedeMPouzols added a commit that referenced this issue Dec 6, 2024
@FedeMPouzols
fix general descr of some quantities (units text), #326
bea71be
FedeMPouzols added a commit that referenced this issue Dec 6, 2024
@FedeMPouzols
update schema version, #326
e43ac5c
@FedeMPouzols FedeMPouzols mentioned this issue Dec 9, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@FedeMPouzols FedeMPouzols

Labels
MSv4 Review
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fixes and improvements in docs and schema from MSv4 review, batch 326 328 334 343 344 casangi/xradio
2 participants
@FedeMPouzols @kswang1029