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

Groomed documentation #88

Merged
merged 6 commits into from
Jan 18, 2022
Merged

Groomed documentation #88

merged 6 commits into from
Jan 18, 2022

Conversation

alxmrs
Copy link
Collaborator

@alxmrs alxmrs commented Jan 17, 2022

  • Fixed mobile responsiveness issue with the sphinx template.
  • Fixed weather-dl: Document the -n argument #46
  • Updated weather-mv docs to reflect need for --temp_location.
  • Fixed a link at the top of the README by extracting a documentation section.

@alxmrs alxmrs requested review from pramodg and uhager January 17, 2022 04:41
@@ -48,6 +45,7 @@ _Usage Examples_:
```bash
weather-mv --uris "gs://your-bucket/*.nc" \
--output_table $PROJECT.$DATASET_ID.$TABLE_ID \
--temp_location "gs://$BUCKET/tmp" \ # Needed for batch writes to BigQuery
Copy link
Contributor

Choose a reason for hiding this comment

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

Is temp_location always required? It should be added above to 'Common options' and marked as '(required)' if applicable.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks! This argument is not always required – only for batch uploads (the BigQuery transform needs it). For the streaming use case, this is not necessary.

@alxmrs alxmrs merged commit cf96e01 into main Jan 18, 2022
@alxmrs alxmrs deleted the update-docs branch January 19, 2022 01:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

weather-dl: Document the -n argument
3 participants