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

Updating Doc String: Address Issue #258 #263

Open
wants to merge 4 commits into
base: devel
Choose a base branch
from

Conversation

csdechant
Copy link
Collaborator

This PR updates the Zapdos header files to include previously missing Doc String, which will close Issue #258. This PR also includes minor edits that remove previously unused parameters in Zapdos objects.

Updating the docstings in Zapdos is in progress with the following objects completed:
- Actions
- Auxkernels
- bcs
- constraits
- indicators
- interfacekernels
- postprocessors
- userobjects
Also minor edits of head and body files were done, which involved removing out dated parameters
@moosebuild
Copy link
Collaborator

Job Precheck, step Clang format on c1357a1 wanted to post the following:

Your code requires style changes.

A patch was auto generated and copied here
You can directly apply the patch by running, in the top level of your repository:

curl -s https://mooseframework.inl.gov/zapdos/docs/PRs/263/clang_format/style.patch | git apply -v

Alternatively, with your repository up to date and in the top level of your repository:

git clang-format e8985332e9881d2c29ffaae068c7c094c8b545ac

@csdechant
Copy link
Collaborator Author

csdechant commented Nov 13, 2024

The PR for updating Zapdos Doc Sting is ready for review. @gsgall is the primary reviewer, but I included @cticenhour in case he would like to look at this PR too.

@moosebuild
Copy link
Collaborator

Job Documentation, step Sync to remote on 52b53b9 wanted to post the following:

View the site here

This comment will be updated on new commits.

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.

2 participants