Overall doc review #130
Merged
Overall doc review #130
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
|
Thanks a lot @PipKat !! |
PipKat
commented
Jan 29, 2024
PipKat
commented
Jan 29, 2024
PipKat
commented
Jan 29, 2024
PipKat
commented
Jan 29, 2024
PipKat
commented
Jan 29, 2024
PipKat
commented
Jan 29, 2024
PipKat
commented
Jan 29, 2024
PipKat
commented
Jan 29, 2024
PipKat
commented
Jan 29, 2024
PipKat
commented
Jan 29, 2024
PipKat
commented
Jan 29, 2024
PipKat
commented
Jan 29, 2024
PipKat
commented
Jan 29, 2024
SMoraisAnsys
force-pushed
the
doc/overall_review_descriptive_content
branch
from
72310e9 to
354881a
Compare
SMoraisAnsys
previously approved these changes
Jan 31, 2024
There was a problem hiding this comment.
Everything has been taken into account. Thanks again @PipKat
PipKat
commented
Jan 31, 2024
PipKat
commented
Jan 31, 2024
Co-authored-by: Kathy Pippert <[email protected]>
Co-authored-by: Kathy Pippert <[email protected]>
SMoraisAnsys
approved these changes
Feb 1, 2024
svandenb-dev
added a commit
that referenced
this pull request
Mar 13, 2025
* test #47 done * test #48 done * test #49 done * test #49 done * test #50 done * test #51 done * test #52 done * test #53 done * test #54 done * test #55 done * test #56 done * test #57 done * test #58 done * test #59 done * test #60 done * test #61 done * test #62 done * test #62 done * test #63 done * test #64 done * test #65 done * test #66 done * test #67 done * test #68 done * test #69 done * test #70 done * test #71 done * test #72 done * test #73 done * test #74 done * test #75 done * test #75 done * test #76 done * test #77 done * test #78 done * test #79 done * test #80 done * test #81 done * test #82 done * test #83 done * test #83 done * test #84 done * test #85 done * test #86 done * test #87 done * test #88 done * test #89 done * test #90 done * test #91 done * test #92 done * test #93 done * test #94 done * test #95 done * test #96 done * test #96 done * material done * test #97 * test #98 * test #98 * test #100 * test #101 * rpc init * rpc server * rpc server * rpc server * rpc server * added new method to plot * test #101 * layout plot updated * refactor naming * test 104 * Added new common class and refactored Plot method * Added new common class and refactored Plot method * Added new common class and refactored Plot method * Fixed UT * test 105 * test 110 * test #112 * test #113 * test #114 * test #ipc * ipc grpc * added requirements * modeler * added requirements * added requirements * REFACTOR: Material implementation * test modeler duplicate * test modeler #2 * test modeler #arbitrary waveports * test modeler #arbitrary waveports * test modeler #4 * test modeler #5 * test modeler #6 * test modeler #7 * test materials completed * test materials completed * test materials completed * mesh op fix * custom cutout 0 fixed * component * test #110 * test #111 * test #112 * test #113 * test #114 * test #115 * test #116 * test #117 * test #118 * test #119 * test #120 * test #121 * test #120 * test #121 * test #130 * test #131 * test #132 * test #133 * test #134 * test #134 * new feature via clustering * edbcore doc removing * edbcore doc removing * bug fix * grpc * grpc * Fixed grpc layer construction * grpc * grpc * grpc * edb caching * revert * revert * ipc caching * ipc caching * ipc caching * test modeler * edb grpc * doc string * renaming EdbGrpc to Edb * doc string * doc refactoring * doc refactoring * doc refactoring * doc refactoring * doc refactoring * doc refactoring * doc refactoring * doc refactoring * doc refactoring * doc refactoring * doc refactoring * doc refactoring * doc refactoring * doc refactoring * doc refactoring * doc refactoring * doc refactoring all ref pass * doc refactoring all ref pass * doc refactoring all ref pass * doc refactoring all ref pass * doc refactoring all ref pass * doc refactoring all ref pass * doc refactoring * bundle terminal docstring * terminal docstring * terminal docstring * def docstring * def docstring * material docstring * docstring * geometry docstring * component.py docstring * docstring * docstring * doc string * doc string * doc string * ports doc string * primitive.py doc string * simulation_setup.py doc string * utility.py doc string * example repo doc string * removing caching * rpc_session.py * grpc optim speed * fixes for test_edb.py * fixes for test_edb.py part 2 * adding grpc tag * doc removed * doc removed * .NET doc recovered * cicd * grpc markers * grpc markers * grpc markers * grpc markers * grpc markers * doc fix * pytest mark * pytest mark * pytest mark * cicd * primitive aedt name --------- Co-authored-by: maxcapodi78 <Shark78> Co-authored-by: mcapodif <[email protected]> Co-authored-by: Sebastien Morais <[email protected]> Co-authored-by: dmiller <[email protected]>
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.
For this overall doc review, I was asked to focus only on reviewing the "Getting started" and "User guide" sections. I've also edited the README and documentation landing page to try to reduce redundant and consolidate information in the way that we now prefer. Although I was told not to review the "Examples" and "API reference" section, I would someday like to be given this opportunity to review them as I see ways that the content can be improved. In the meantime, see the questions and suggestions I've left on the files themselves.