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

docs: update README #123

Closed
wants to merge 4 commits into from
Closed

docs: update README #123

wants to merge 4 commits into from

Conversation

RobPasMue
Copy link
Member

As title says

@RobPasMue RobPasMue self-assigned this Aug 31, 2023
@RobPasMue
Copy link
Member Author

@ansys-reviewer-bot help

@RobPasMue
Copy link
Member Author

@ansys-reviewer-bot review

@RobPasMue
Copy link
Member Author

@ansys-reviewer-bot help

@ansys-reviewer-bot
Copy link

I am sorry... I cannot understand your request.

Options are:

  • @ansys-reviewer-bot stop review: to stop the bot from reviewing this PR.
  • @ansys-reviewer-bot review: to ask for a review.

@RobPasMue
Copy link
Member Author

@ansys-reviewer-bot review

@ansys-reviewer-bot
Copy link

Okay, I will trigger a review of your PR.

Co-authored-by: ansys-reviewer-bot[bot] <143693109+ansys-reviewer-bot[bot]@users.noreply.github.com>
README.md Outdated Show resolved Hide resolved
@RobPasMue
Copy link
Member Author

@ansys-reviewer-bot stop review

@ansys-reviewer-bot
Copy link

Okay, I will not perform any more reviews on your PR.

@codecov-commenter
Copy link

Codecov Report

Merging #123 (ebe121e) into main (d889346) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #123   +/-   ##
=======================================
  Coverage   94.20%   94.20%           
=======================================
  Files           3        3           
  Lines          69       69           
=======================================
  Hits           65       65           
  Misses          4        4           

@RobPasMue
Copy link
Member Author

@ansys-reviewer-bot stop review

@ansys-reviewer-bot
Copy link

Okay, I will not perform any more reviews on your PR.

@RobPasMue
Copy link
Member Author

@ansys-reviewer-bot help

@ansys-reviewer-bot
Copy link

I am sorry... I cannot understand your request.

Options are:

  • @ansys-reviewer-bot stop review: to stop the bot from reviewing this PR.
  • @ansys-reviewer-bot review: to ask for a review.

@RobPasMue
Copy link
Member Author

@ansys-reviewer-bot stop review

@ansys-reviewer-bot
Copy link

Okay, I will not perform any more reviews on your PR.

@RobPasMue
Copy link
Member Author

@ansys-reviewer-bot review

@ansys-reviewer-bot
Copy link

Okay, I will trigger a review of your PR.

@RobPasMue
Copy link
Member Author

@ansys-reviewer-bot review

@ansys-reviewer-bot
Copy link

Okay, I will trigger a review of your PR.

@RobPasMue
Copy link
Member Author

@ansys-reviewer-bot review

@ansys-reviewer-bot
Copy link

Okay, I will trigger a review of your PR.

@RobPasMue
Copy link
Member Author

@ansys-reviewer-bot review

@ansys-reviewer-bot
Copy link

Okay, I will trigger a review of your PR.

@@ -9,7 +9,7 @@
[![Black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat)](https://github.com/psf/black)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ansys/pyansys-tools-report/main.svg)](https://results.pre-commit.ci/latest/github/ansys/pyansys-tools-report/main)

Choose a reason for hiding this comment

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

Change the sentence structure slightly for better readability:

Suggested change
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ansys/pyansys-tools-report/main.svg)](https://results.pre-commit.ci/latest/github/ansys/pyansys-tools-report/main)
A Python environment reporting tool tailored specifically for PyAnsys package versions and hardware resources, provided in a standardized way.

@@ -9,7 +9,7 @@
[![Black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat)](https://github.com/psf/black)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ansys/pyansys-tools-report/main.svg)](https://results.pre-commit.ci/latest/github/ansys/pyansys-tools-report/main)

Choose a reason for hiding this comment

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

Consider replacing "tailored" with "designed" to convey the purpose of the tool more clearly:
Example: "A Python environment reporting tool designed specifically for PyAnsys package versions and hardware resources, provided in a standardized way."

@RobPasMue RobPasMue closed this Sep 8, 2023
@RobPasMue RobPasMue deleted the docs/update-readme branch May 24, 2024 10:08
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.

None yet

2 participants