You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The README file for a PyAnsys library usually has a "License" section. See the PyAEDT README file. Does such a section need to be added to the PyHPS README file? Note that the links in the README file for the documentation and its sections will have to be updated with the URLs for the stable documentation once the library is released. The current links are to the documentation for the dev version because it is currently the only version that exists.
The installation information in the "Getting started" and "Contribute" sections will have to be updated to convey the steps appropriate for the library once it is made public.
In the "User guide" section, I'd recommend breaking out the content currently on the landing page into these additional pages: Query parameters, Objects versus dictionaries, Common tasks, and Exception handling. (There is likely a better name than "Common tasks" for this how-to usage content. However, I couldn't easily come up with one!) I didn't want to make such changes in this PR because it will already have conflicts with changes Kerry has made in the PR for her technical review. If you want me to do a reorganization of this section in another PR after both this and Kerry's PRs are merged, let me know.
The "Examples" section is now showing links in the left navigation pane, although in the previous doc build it wasn't!? Also, should the landing page for this section (and examples) show the default username and password--and what format is the version provided in? (Usually it's in three digits [such as 241] rather than written as "2024 R1"). Lastly, I fixed minor grammar errors in the files shown via includes. For example, I changed "setup" to "set up" when it was used as a verb. However, I hope it was OK to edit the files that appear via includes because they are also included in the ZIP file for the example (and I don't know how/when this ZIP file is generated). ADDITION: For includes, consider using the start_at attribute to omit licensing information showing in the doc? This would save a lot of screen space.
In the "API reference" section, the right navigation pane only shows links to the top-level sections. It is really hard to find information within these sections. In the auth.rst file, there is a TODO REVIEW paragraph that must definitely be removed! Also, lots of objects are missing descriptions. Would we be able to improve this section before releasing publicly?
Rename REP to HPS
The text was updated successfully, but these errors were encountered:
Originally posted by Kathy: #278 (comment)
includes
. For example, I changed "setup" to "set up" when it was used as a verb. However, I hope it was OK to edit the files that appear viaincludes
because they are also included in the ZIP file for the example (and I don't know how/when this ZIP file is generated). ADDITION: Forincludes
, consider using thestart_at
attribute to omit licensing information showing in the doc? This would save a lot of screen space.auth.rst
file, there is a TODO REVIEW paragraph that must definitely be removed! Also, lots of objects are missing descriptions. Would we be able to improve this section before releasing publicly?The text was updated successfully, but these errors were encountered: