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 BCs Documentation #250

Merged
merged 12 commits into from
Nov 6, 2024
Merged

Conversation

csdechant
Copy link
Collaborator

This PR is part of a continuing effort update the Zapdos documentation. In particular, this PR focuses on the documentation for the Boundary Conditions (BC) objects.

@csdechant csdechant requested a review from gsgall June 13, 2024 15:50
@csdechant
Copy link
Collaborator Author

Just a reminder for our email conversation, I haven't fully proofread the documentation, so please excuse any typos/left over self-notes.

@moosebuild
Copy link
Collaborator

Job Documentation on df3868b wanted to post the following:

View the site here

This comment will be updated on new commits.

doc/content/source/bcs/CircuitDirichletPotential.md Outdated Show resolved Hide resolved
doc/content/source/bcs/CircuitDirichletPotential.md Outdated Show resolved Hide resolved
doc/content/source/bcs/CircuitDirichletPotential.md Outdated Show resolved Hide resolved
doc/content/source/bcs/SecondaryElectronEnergyBC.md Outdated Show resolved Hide resolved
doc/content/source/bcs/SecondaryElectronEnergyBC.md Outdated Show resolved Hide resolved
doc/content/source/bcs/SecondaryElectronEnergyBC.md Outdated Show resolved Hide resolved
doc/content/source/bcs/SecondaryElectronEnergyBC.md Outdated Show resolved Hide resolved
doc/content/source/bcs/SecondaryElectronEnergyBC.md Outdated Show resolved Hide resolved
@gsgall gsgall mentioned this pull request Jun 25, 2024
csdechant and others added 3 commits June 25, 2024 13:00
Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>
@moosebuild
Copy link
Collaborator

moosebuild commented Oct 23, 2024

Job Documentation, step Sync to remote on 0148c94 wanted to post the following:

View the site here

This comment will be updated on new commits.

@moosebuild
Copy link
Collaborator

Job Precheck, step Clang format on 77376df 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/250/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 d16eeb0d73e664e51210f4017a757e46a96b0c85

@csdechant
Copy link
Collaborator Author

csdechant commented Oct 23, 2024

@gsgall @cticenhour This PR is ready for another review. There are some unresolved conversations that focuses on formatting, but nothing too big.

@gsgall
Copy link
Collaborator

gsgall commented Oct 28, 2024

Thank you @csdechant! I should be able to give this a review Thursday or Friday this week. This weekend at the latest.

@csdechant
Copy link
Collaborator Author

@cticenhour Your edits to CIVET seemed to work, as this branch fails precheck due to not referencing an issue number. I will edit the last commit message to reference issue #260

Copy link
Collaborator

@gsgall gsgall left a comment

Choose a reason for hiding this comment

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

Sorry for the delay on my review, took longer than expected. Overall great work on addressing the changes @csdechant! I found a few more common typos. A lot of these are just the same sort of typos that were addressed in the previous review. But I think we're almost there!

src/bcs/CircuitDirichletPotential.C Outdated Show resolved Hide resolved
doc/content/source/bcs/CircuitDirichletPotential.md Outdated Show resolved Hide resolved
doc/content/source/bcs/CircuitDirichletPotential.md Outdated Show resolved Hide resolved
doc/content/source/bcs/CircuitDirichletPotential.md Outdated Show resolved Hide resolved
doc/content/source/bcs/CircuitDirichletPotential.md Outdated Show resolved Hide resolved
doc/content/source/bcs/SakiyamaSecondaryElectronBC.md Outdated Show resolved Hide resolved
doc/content/source/bcs/SchottkyEmissionBC.md Outdated Show resolved Hide resolved
doc/content/source/bcs/SchottkyEmissionBC.md Outdated Show resolved Hide resolved
doc/content/source/bcs/SchottkyEmissionBC.md Outdated Show resolved Hide resolved
doc/content/source/bcs/SecondaryElectronEnergyBC.md Outdated Show resolved Hide resolved
csdechant and others added 3 commits November 5, 2024 10:06
Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>
Co-authored-by: Grayson Gall <66559200+gsgall@users.noreply.github.com>
@csdechant
Copy link
Collaborator Author

@gsgall That should be all the new edits. If there is nothing else, I think this PR is ready to go.

Copy link
Collaborator

@gsgall gsgall left a comment

Choose a reason for hiding this comment

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

Looks good to me. Thank you @csdechant. I think we just need @cticenhour to do a review since I don't have merge permission.

@csdechant
Copy link
Collaborator Author

csdechant commented Nov 6, 2024

Looks good to me. Thank you @csdechant. I think we just need @cticenhour to do a review since I don't have merge permission.

Yes, you still only have Triage access for now. Casey and I talked about changing your role for the coming up thesis PRs, but I technically can change you to have Write or Admin access right now.

@cticenhour did you have any concerns about changing Grayson's role and having him push this PR? I personal think he should be changed to Admin now.

@cticenhour
Copy link
Member

I think @gsgall did a great job on reviews here, and have no problem with him getting Admin rights. Since Zapdos efforts will begin to feed into the FENIX project soon, we'll need more reviewers available with high review standards!

@csdechant
Copy link
Collaborator Author

@gsgall you should official have Admin rights now. This PR is showing all green on my end, indicating GitHub accepts the role changes for this PR.

@csdechant csdechant merged commit 5d2155f into shannon-lab:devel Nov 6, 2024
3 checks passed
@csdechant csdechant deleted the website-BCs branch November 6, 2024 18:17
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.

4 participants