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

Modernize the scripting page of the API docs #1661

Merged
merged 3 commits into from
Oct 24, 2024

Conversation

phargogh
Copy link
Member

This PR updates scripting page of the API docs, with the largest changes being:

  • Installation steps recommend using conda or mamba to create an environment
  • Installation steps now refer to the installation page for more information
  • Screenshot links are no longer broken.
  • Updated the sample InVEST script to what InVEST currently generates
  • Updated the logging section to reflect recent changes in default logging in the templated script

Fixes #1660

Checklist

  • Updated HISTORY.rst and link to any relevant issue (if these changes are user-facing)
    - [ ] Updated the user's guide (if needed)
    - [ ] Tested the Workbench UI (if relevant)

@phargogh phargogh requested a review from emlys October 23, 2024 18:04
doc/api-docs/scripting.rst Outdated Show resolved Hide resolved
Copy link
Member

@emlys emlys left a comment

Choose a reason for hiding this comment

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

Thanks @phargogh! Just one typo suggestion. And for the section header "Creating Sample Python Scripts", I'm not sure the word "Sample" is adding anything there (or maybe I'm not understanding it). Suggest "Creating Python Scripts" instead.

@phargogh phargogh requested a review from emlys October 23, 2024 20:10
@emlys emlys merged commit 4a4d6b7 into natcap:main Oct 24, 2024
29 checks passed
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.

Batch processing API docs page is woefully out of date
2 participants