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.

Sign up for GitHub

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

Jump to bottom

Bracket example #2365

Merged
merged 22 commits into from
Oct 2, 2023
Merged

Bracket example #2365

merged 22 commits into from
Oct 2, 2023

Conversation

germa89
Copy link
Collaborator

@germa89 germa89 commented Sep 26, 2023 •
edited

As the title.

Close #2156

@ansys-reviewer-bot
Copy link
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

@germa89 germa89 self-assigned this Sep 26, 2023
@germa89 germa89 added the Documentation Documentation related (improving, adding, etc) label Sep 26, 2023
@germa89
Copy link
Collaborator Author

germa89 commented Sep 26, 2023

@ansys-reviewer-bot review

@ansys-reviewer-bot
Copy link
Contributor

Okay, I will trigger a review of your PR.

@codecov
Copy link

codecov bot commented Sep 26, 2023 •
edited

Codecov Report

Merging #2365 (942ff03) into main (8a4235e) will increase coverage by 0.34%.
Report is 1 commits behind head on main.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #2365      +/-   ##
==========================================
+ Coverage   87.45%   87.79%   +0.34%     
==========================================
  Files          44       44              
  Lines        8455     8455              
==========================================
+ Hits         7394     7423      +29     
+ Misses       1061     1032      -29

@germa89 germa89 changed the title Braket example Bracket example Sep 26, 2023
@germa89
Copy link
Collaborator Author

germa89 commented Sep 26, 2023

Please @mcMunich review this!

@germa89
Copy link
Collaborator Author

germa89 commented Sep 26, 2023

@mcMunich @pmaroneh ideally this is the format I would like for the examples.

@germa89
Copy link
Collaborator Author

germa89 commented Sep 26, 2023

Please @clatapie do a review on this example. I believe technically is OK. So you should be quick.

@PipKat please could you (or anyone in your team) have a look at this?

@germa89 germa89 marked this pull request as ready for review September 26, 2023 16:09
PipKat
PipKat approved these changes Sep 29, 2023
View reviewed changes
Copy link
Member

@PipKat PipKat left a comment

Choose a reason for hiding this comment

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

Lots of changes from "we" to "you" as well as from future tense to present tense and passive voice to active voice. This is one of the best explained examples that I've seen!

germa89 and others added 2 commits October 2, 2023 10:18
@germa89 @PipKat @clatapie
Apply suggestions from code review
645d8ed 
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
Co-authored-by: Camille <78221213+clatapie@users.noreply.github.com>
@pre-commit-ci
[pre-commit.ci] auto fixes from pre-commit.com hooks
0379351 
for more information, see https://pre-commit.ci
@germa89
Copy link
Collaborator Author

germa89 commented Oct 2, 2023

Lots of changes from "we" to "you" as well as from future tense to present tense and passive voice to active voice. This is one of the best explained examples that I've seen!

Thanks to @mcMunich, he wrote it. I just did the technical review. :)

@PipKat
Copy link
Member

PipKat commented Oct 2, 2023

@germa89 @clatapie Just wanted to say that according to the Ansys Guide to Documentation Writing Style, we should all be using von Mises. (Do no capitalize “von” but do capitalize “Mises”.)

@germa89 germa89 enabled auto-merge (squash) October 2, 2023 15:47
@germa89 germa89 merged commit 05ba35d into main Oct 2, 2023
21 checks passed
@germa89 germa89 deleted the doc/bracket-example_2 branch October 2, 2023 15:47
@mcMunich
Copy link
Contributor

mcMunich commented Oct 4, 2023

Lots of changes from "we" to "you" as well as from future tense to present tense and passive voice to active voice. This is one of the best explained examples that I've seen!

I meant the royal we.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@clatapie clatapie clatapie approved these changes

@ansys-reviewer-bot ansys-reviewer-bot[bot] ansys-reviewer-bot left review comments

@koubaa koubaa koubaa approved these changes

@PipKat PipKat PipKat approved these changes

Assignees

@germa89 germa89

@clatapie clatapie

@PipKat PipKat

Labels
Documentation Documentation related (improving, adding, etc)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

APDL Classic Bracket Example
5 participants
@germa89 @PipKat @mcMunich @koubaa @clatapie