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

API and contribution sections small reorganization #2491

Merged
merged 10 commits into from
Nov 21, 2023
Merged

API and contribution sections small reorganization #2491

merged 10 commits into from
Nov 21, 2023

Conversation

germa89
Copy link
Collaborator

@germa89 germa89 commented Nov 7, 2023

API section small reorg.

Extended documentation about writing example and developing PyMAPDL.

Close #2398

@germa89
API reog.
aa0f8cc 
Extended documentation about writing example and developing PyMAPDL.
@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

@github-actions github-actions bot added the Documentation Documentation related (improving, adding, etc) label Nov 7, 2023
@germa89 germa89 changed the title API reog. API small reorganization Nov 7, 2023
@germa89 germa89 changed the title API small reorganization API and contribution sections small reorganization Nov 7, 2023
@codecov Codecov
Copy link

codecov bot commented Nov 7, 2023 •
edited

Codecov Report

Merging #2491 (46187f0) into main (949b8d8) will decrease coverage by 0.03%.
Report is 14 commits behind head on main.
The diff coverage is n/a.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #2491      +/-   ##
==========================================
- Coverage   83.83%   83.81%   -0.03%     
==========================================
  Files          44       44              
  Lines        8685     8685              
==========================================
- Hits         7281     7279       -2     
- Misses       1404     1406       +2

PipKat
PipKat approved these changes Nov 9, 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.

@germa89 The new content here is great. My concern is that I believe most of it would be better placed in central documents (PyAnsys Developer's Guide and PyAnsys Writer's Guide) so that the documentation for all guides can reference it, and then this content would only need to be maintained in one place. Adding @MaxJPRey and @RobPasMue for feedback.

@germa89
Copy link
Collaborator Author

germa89 commented Nov 20, 2023 •
edited

Pinging @SMoraisAnsys for accepts.txt review.

@germa89 germa89 self-assigned this Nov 21, 2023
@germa89 germa89 enabled auto-merge (squash) November 21, 2023 10:59
@germa89 germa89 merged commit e1034f3 into main Nov 21, 2023
23 checks passed
@germa89 germa89 deleted the doc/API-reorg branch November 21, 2023 11:22
@germa89 germa89 mentioned this pull request Feb 5, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RobPasMue RobPasMue RobPasMue left review comments

@PipKat PipKat PipKat approved these changes

@MaxJPRey MaxJPRey MaxJPRey left review comments

@koubaa koubaa koubaa approved these changes

@clatapie clatapie Awaiting requested review from clatapie

@SMoraisAnsys SMoraisAnsys Awaiting requested review from SMoraisAnsys

Assignees

@germa89 germa89

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

Successfully merging this pull request may close these issues.

Docs reog?
5 participants
@germa89 @koubaa @RobPasMue @PipKat @MaxJPRey