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

Extend Actuator Disk documentation #304

Merged
merged 1 commit into from
Sep 6, 2023

Conversation

DavidAnderegg
Copy link
Collaborator

Purpose

I started using actuator disks and was confused as how they are defined. This is my attempt to make the documentation a bit more clear.

Expected time until merged

Type of change

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (non-backwards-compatible fix or feature)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Documentation update
  • Maintenance update
  • Other (please describe)

Testing

Checklist

  • I have run flake8 and black to make sure the Python code adheres to PEP-8 and is consistently formatted
  • I have formatted the Fortran code with fprettify or C/C++ code with clang-format as applicable
  • I have run unit and regression tests which pass locally with my changes
  • I have added new tests that prove my fix is effective or that my feature works
  • I have added necessary documentation

@DavidAnderegg DavidAnderegg requested a review from a team as a code owner August 14, 2023 08:31
@anilyil anilyil requested review from ArshSaja and removed request for eirikurj August 14, 2023 08:31
@codecov
Copy link

codecov bot commented Aug 14, 2023

Codecov Report

Merging #304 (d0e8f01) into main (b0b6a6d) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #304   +/-   ##
=======================================
  Coverage   41.98%   41.98%           
=======================================
  Files          13       13           
  Lines        4001     4001           
=======================================
  Hits         1680     1680           
  Misses       2321     2321           
Files Changed Coverage Δ
adflow/pyADflow.py 68.94% <ø> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@DavidAnderegg
Copy link
Collaborator Author

I have no clue why the sphinx build fails. It works locally.

Also, when I click on the details page about that failed test, I get a 404.

@eirikurj
Copy link
Contributor

This is due to RTD brownout since they are now requiring a build config file for all repos (see https://blog.readthedocs.com/migrate-configuration-v2/ for details). We are currently planning how to manage this file on the organization level, primarily to minimize our maintenance work. We plan to add this file soon, so there is no need to do anything here.

@anilyil anilyil merged commit f162cfb into mdolab:main Sep 6, 2023
@DavidAnderegg DavidAnderegg deleted the actuatorDocs branch September 25, 2023 15: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.

3 participants