-
Notifications
You must be signed in to change notification settings - Fork 9
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
Rewrite PyDPF-Post doc to PyAnsys library style guidelines #785
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #785 +/- ##
=======================================
Coverage 85.11% 85.11%
=======================================
Files 52 52
Lines 5208 5208
=======================================
Hits 4433 4433
Misses 775 775 |
@PipKat - looks like my change didn't work. Maybe @Revathyvenugopal162 can look into it a bit more in depth? |
@PProfizi and @cbellot000 I think you guys can review this PR, and we can get it merged. I can work with Revathy later to get the spacing problem of images and subsequent subheadings appearing on the same line if the images are left-aligned. In the meantime, I'll center align the images referenced in the description. NOTE: The images in the examples are left-aligned, so there must be a way to do a left alignment in reStructuredText files! Also, I didn't do any editing of the "API reference" section. I assumed you'd be working with @moe-ad to update this section. I'd be happy to do a complete doc review of this section after reworking it. |
examples/00-Different-analysis-types/03-transient-simulation.py
Outdated
Show resolved
Hide resolved
examples/00-Different-analysis-types/04-harmonic-complex-results.py
Outdated
Show resolved
Hide resolved
examples/00-Different-analysis-types/04-harmonic-complex-results.py
Outdated
Show resolved
Hide resolved
examples/00-Different-analysis-types/04-harmonic-complex-results.py
Outdated
Show resolved
Hide resolved
examples/01-Detailed-Examples/03-explore-result-data-harmonic.py
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @PipKat, finished my review. Thanks for the huge amount of work this must have been!
…/reditorial_review
Implement Paul's suggestions Co-authored-by: Paul Profizi <100710998+PProfizi@users.noreply.github.com>
@PProfizi I need you or someone else to approve this PR to be able to merge it! Thanks! |
Ready for review.
Implemented cards on index pages of "Getting started" and "User guide" sections and did an overall review of these sections and the "Examples" and "Contribute" sections. I will do an overall review of the "API reference" section after it uses the new styling, which was recently implemented in PyDPF-Core.
@RobPasMue There are two pages in the HTML artifact where images and a heading for a subsequent section run together. One page is "Brief demo" ( demo.rst) in the "Getting started" section. The other page is "Plot results" (plotting.rst) in the "User guide" section. I changed the directive from figure to image thinking that might fix it. However, it didn't. Do you know how I can get the next section on a new line? Copilot said to put a blank line after the block. However, there are two blank lines already there.