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

Mostieri/address further tech review comments #18

Merged
merged 4 commits into from
Oct 21, 2024

Conversation

mariostieriansys
Copy link
Collaborator

Closes #11

Address further tech review comments:

  1. Readme image was broken since I got the documentation from PyEnSight, which is using Sphinx to render the RST. I sorted it out pointing to the image in the PyEnSight folder. While this might be an issue in the future, we will likely overhaul the branch README soon.
  2. I included the exts folder in the doc-style action options
  3. I changed the metadata, since the extension is only supposed to run on Python 3.10 (specifically the Omniverse Python 3.10)
  4. Main change of the PR. We don't run sphinx as part of a build, so the numpydoc style was not enforced. I tried to enforce it via flake8, but for some reason it wasn't finding issues on the exts content. I ended up adding a pre-commit hook specifically designed for the numpydoc validation. Main trouble is that it is quite pedantic, and the suggestions in the docs to set the configuration in the pyproject toml just don't work. I had to add the exclusions in the precommit configuration and several ignore statements in the code. I hope to find a better alternative for the future

Copy link
Member

@RobPasMue RobPasMue left a comment

Choose a reason for hiding this comment

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

LGTM!

.flake8 Outdated Show resolved Hide resolved
@mariostieriansys mariostieriansys merged commit 9c1b12b into main Oct 21, 2024
10 checks passed
@RobPasMue RobPasMue deleted the mostieri/address_further_tech_review_comments branch October 31, 2024 11:34
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.

Technical review
2 participants