shannon-lab / zapdos

Open source MOOSE framework application for simulating plasmas
https://shannon-lab.github.io/zapdos/
GNU Lesser General Public License v2.1
39 stars 38 forks source link

Updating BCs Documentation #250

Closed csdechant closed 2 weeks ago

csdechant commented 5 months ago

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 commented 5 months ago

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

moosebuild commented 5 months ago

Job Documentation on df3868b wanted to post the following:

View the site here

This comment will be updated on new commits.

moosebuild commented 1 month ago

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 commented 1 month ago

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 commented 1 month ago

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

gsgall commented 4 weeks ago

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

csdechant commented 4 weeks ago

@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

csdechant commented 3 weeks ago

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

csdechant commented 2 weeks ago

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 commented 2 weeks ago

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 commented 2 weeks ago

@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.