Skip to content

docs: documentation review changes #483

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

Merged
merged 16 commits into from
Mar 5, 2025
Merged

Conversation

echambla
Copy link
Collaborator

@echambla echambla commented Feb 27, 2025

Description

Please provide a brief description of the changes made in this pull request.

Issue linked

Please mention the issue number or describe the problem this pull request addresses.

Checklist

  • I have tested my changes locally.
  • I have added necessary documentation or updated existing documentation.
  • I have followed the coding style guidelines of this project.
  • I have added appropriate tests (unit, integration, system).
  • I have reviewed my changes before submitting this pull request.
  • I have linked the issue or issues that are solved by the PR if any.
  • I have assigned this PR to myself.
  • I have made sure that the title of my PR follows Conventional commits style (e.g. feat: add optical property)
  • I have agreed with the Contributor License Agreement (CLA).

@echambla echambla self-assigned this Feb 27, 2025
@echambla echambla requested a review from nicolasANSS February 27, 2025 15:40
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 27, 2025
Copy link
Contributor

@SMoraisAnsys SMoraisAnsys left a comment

Choose a reason for hiding this comment

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

From the changes I've seen associated to docstring / ruff, a title shouldn't be conjugated but being imperative. For example

"""Convert a given ...""" instead of """Converts a given ..."""

echambla and others added 4 commits February 27, 2025 17:11
jomadec
jomadec previously approved these changes Feb 27, 2025
@StefanThoene
Copy link
Collaborator

@echambla i think we might want to add these changes after we have merged my branch than you will get errors on pre-commit.

SMoraisAnsys
SMoraisAnsys previously approved these changes Feb 28, 2025
jomadec
jomadec previously approved these changes Mar 5, 2025
pluAtAnsys
pluAtAnsys previously approved these changes Mar 5, 2025
@SMoraisAnsys SMoraisAnsys dismissed stale reviews from pluAtAnsys and jomadec via f85e82b March 5, 2025 14:05
Copy link

github-actions bot commented Mar 5, 2025

The towncrier template has been successfully rewritten with the default template.
Please ensure that sphinx-design is included as a dependency in your project's documentation requirements.
Additionally, add sphinx-design to the extensions list in your conf.py file.
For more information, please refer to the migration guide at:
https://actions.docs.ansys.com/version/stable/migrations/index.html#migration-guide

@echambla echambla requested a review from nicolasANSS March 5, 2025 16:33
@echambla echambla requested a review from SMoraisAnsys March 5, 2025 16:38
@echambla echambla merged commit 4f94d68 into main Mar 5, 2025
27 checks passed
@echambla echambla deleted the docs/doc-review-modification branch March 5, 2025 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants