Sparse documentation?

[arfc]

Sparse documentation?

[yardasol]

Hmm, well now with these edits I think it is closer to being its own issue now, so maybe hold off on closing it just yet?

[katyhuff]

A contributing.md document exists and Moltres follows the MOOSE style guide and is not duplicated in this repo (because D.R.Y.). Please see my comments on the other issues with respect to these notes.

I understand that as a new user, you may feel confused by some of the documentation and I support improvements for clarity. I encourage those changes that you feel would be helpful. However, I also would like to take this moment to express that issues and PRs in this repository are part of the larger scope of professional engagements in ARFC over which the code of conduct applies. I'd like to request a more respectful and generous tone in such engagements to communicate due respect for the previous authors of this work, many of whom are your colleagues, one of whom is your advisor, and one of whom we are deeply grateful to for the sheer existence of Moltres. Entitling this issue "Insufficient documentation throughout Moltres" and characterizing the documentation situation as "generally insufficient" seems a bit baseless, given that moltres has been used by many students, including a complete stranger on another continent who required no assistance from us to incorporate Moltres simulations as a pivotal component of their PhD dissertation.

[katyhuff]

Since this issue merely exists to refer to other subissues, I'd like to close it as duplicative. What do you think @yardasol?

[yardasol]

I agree that this issue should be closed as duplicative.

[yardasol]

A contributing.md document exists and Moltres follows the MOOSE style guide and is not duplicated in this repo (because D.R.Y.). Please see my comments on the other issues with respect to these notes.

I understand that as a new user, you may feel confused by some of the documentation and I support improvements for clarity. I encourage those changes that you feel would be helpful. However, I also would like to take this moment to express that issues and PRs in this repository are part of the larger scope of professional engagements in ARFC over which the code of conduct applies. I'd like to request a more respectful and generous tone in such engagements to communicate due respect for the previous authors of this work, many of whom are your colleagues, one of whom is your advisor, and one of whom we are deeply grateful to for the sheer existence of Moltres. Entitling this issue "Insufficient documentation throughout Moltres" and characterizing the documentation situation as "generally insufficient" seems a bit baseless, given that moltres has been used by many students, including a complete stranger on another continent who required no assistance from us to incorporate Moltres simulations as a pivotal component of their PhD dissertation.

@katyhuff okay so I made some more edits and I think this issue is more appropriately worded now.

[katyhuff]

Thanks!!

[smpark7]

I've just briefly checked through a few of the kernel .h files and I noticed that some (e.g. GroupDiffusion.h) are missing documentation.

We can make a list of these files and make the appropriate edits to the documentation. In case you didn't know, here's a thorough breakdown of an example Moltres input file. If you're planning to work on this issue, you can ping me when you need help.

[yardasol]

Good idea with making the list. I've made a textfile in the docum (short for documentation) branch of my arfc repo that has the names of all the files in src/ and include/ and is ready to be filled in with what changes or additions we should make for each file. I don't anticipate needing help on that, and it'll be a good opportunity to really get familiar with the overall structure of Moltres. Once I have gone through all the files in those directories and filled in what needs to be done, I'll ping here. Let me know if you think there are other places in the repo that I should put on the list.

[yardasol]

unassigning myself from this because I'm not likely to get around to it any time soon and am less familiar with Moltres than some of the other people in the group.

[smpark7]

I'm closing this because the points here are covered by newer issues #179, #191, and #193