docs[webapi]: add missing webapi methods to docs and reorganize sections #2588
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
LGTM
2 files reviewed, no comments
Edit PR Review Bot Settings | Greptile
yaugenst-flex
force-pushed
the
yaugenst-flex/docs-gettask
branch
from
869a14e to
744a69a
Compare
Diff CoverageDiff: origin/develop...HEAD, staged and unstaged changes
Summary
|
e-g-melo
approved these changes
Jun 20, 2025
yaugenst-flex
force-pushed
the
yaugenst-flex/docs-gettask
branch
from
744a69a to
746e9d8
Compare
…and reorganize sections
yaugenst-flex
force-pushed
the
yaugenst-flex/docs-gettask
branch
from
746e9d8 to
960330e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Greptile Summary
Documentation improvements for Web API methods, focusing on better organization and type annotations in the Tidy3D codebase.
get_run_info()andabort()intidy3d/web/api/webapi.pyaccount()andtest()functions with comprehensive sections (Parameters, Returns, Examples)docs/api/submit_simulations.rstinto logical sections (Core Workflow, Download Utilities, etc.)download_hdf5,get_run_info, andget_tasks