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

Add references to MCNP user manual and documentation updates #417

Merged
merged 21 commits into from
Jun 25, 2024

Conversation

MicahGale
Copy link
Collaborator

@MicahGale MicahGale commented Jun 19, 2024

Description

This is currently a draft playbox right now.

This won't address #413, but put the machinery in place for it. This is also related to #414, but won't close it.

Fixes #412, fixes #416.

Checklist

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation (if applicable)
  • I have added tests that prove my fix is effective or that my feature works (if applicable)

@MicahGale MicahGale changed the title Mcnp see also Add references to MCNP user manual and documentation updates Jun 19, 2024
@coveralls
Copy link
Collaborator

coveralls commented Jun 19, 2024

Pull Request Test Coverage Report for Build 9587963337

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 98.223%

Totals Coverage Status
Change from base Build 9550865708: 0.0%
Covered Lines: 5750
Relevant Lines: 5854

💛 - Coveralls

@MicahGale MicahGale added documentation Improvements or additions to documentation CI/CD labels Jun 19, 2024
@MicahGale MicahGale self-assigned this Jun 21, 2024
@coveralls
Copy link
Collaborator

coveralls commented Jun 21, 2024

Pull Request Test Coverage Report for Build 9617441527

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 98.223%

Totals Coverage Status
Change from base Build 9550865708: 0.0%
Covered Lines: 5750
Relevant Lines: 5854

💛 - Coveralls

@tjlaboss
Copy link
Collaborator

Another issue I found. I think they used \LaTeX and so there's a difference between section and subsection (and probably subsubsection). See https://mcnp.lanl.gov/pdf_files/TechReport_2022_LANL_LA-UR-22-30006Rev.1_KuleszaAdamsEtAl.pdf#section5.2

The MCNP6.3 manual uses

  • part
    • chapter
      • section
        • subsection

and a few special cases. So, we should add a general case, and possibly "part" and "chapter" as well.

@MicahGale
Copy link
Collaborator Author

I think subsection will be the most commonly used so I think that should get :manual63:, then we could do :manual63sect: ... part: ... chap:.

@MicahGale
Copy link
Collaborator Author

Also I looked into the UTF-8 decode error, and it makes no sense, so yay.

@coveralls
Copy link
Collaborator

coveralls commented Jun 22, 2024

Pull Request Test Coverage Report for Build 9622416857

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 98.223%

Totals Coverage Status
Change from base Build 9550865708: 0.0%
Covered Lines: 5750
Relevant Lines: 5854

💛 - Coveralls

@coveralls
Copy link
Collaborator

coveralls commented Jun 22, 2024

Pull Request Test Coverage Report for Build 9622432207

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 98.223%

Totals Coverage Status
Change from base Build 9622313437: 0.0%
Covered Lines: 5750
Relevant Lines: 5854

💛 - Coveralls

@coveralls
Copy link
Collaborator

coveralls commented Jun 24, 2024

Pull Request Test Coverage Report for Build 9648770880

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 98.223%

Totals Coverage Status
Change from base Build 9622313437: 0.0%
Covered Lines: 5750
Relevant Lines: 5854

💛 - Coveralls

@MicahGale MicahGale marked this pull request as ready for review June 24, 2024 16:49
@MicahGale MicahGale requested a review from tjlaboss June 24, 2024 16:49
@coveralls
Copy link
Collaborator

coveralls commented Jun 24, 2024

Pull Request Test Coverage Report for Build 9649231254

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 98.223%

Totals Coverage Status
Change from base Build 9622313437: 0.0%
Covered Lines: 5750
Relevant Lines: 5854

💛 - Coveralls

@coveralls
Copy link
Collaborator

coveralls commented Jun 24, 2024

Pull Request Test Coverage Report for Build 9649924910

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 98.223%

Totals Coverage Status
Change from base Build 9622313437: 0.0%
Covered Lines: 5750
Relevant Lines: 5854

💛 - Coveralls

@MicahGale MicahGale merged commit f2efd34 into develop Jun 25, 2024
14 checks passed
@MicahGale MicahGale deleted the mcnp_see_also branch June 25, 2024 18:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Developer's Guide Bad doc numbering
3 participants