Adding documentation of mass matrix #15
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR updates the MassMatrix documentation examples by removing legacy YAML front matter and streamlining both the Markdown and Fortran example code for improved readability and consistency.
- Removed redundant metadata from Markdown files
- Simplified Fortran examples by replacing excessive inline notes with clear Fortran comments
- Updated variable names in one example to improve consistency
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/docs-api/MassMatrix/examples/_MassMatrix_test_2.md | Removed YAML metadata and simplified example text |
| docs/docs-api/MassMatrix/examples/_MassMatrix_test_2.F90 | Streamlined inline comments and code formatting |
| docs/docs-api/MassMatrix/examples/_MassMatrix_test_1.F90 | Updated variable names and parameter definitions for clarity |
| docs/docs-api/MassMatrix/examples/MassMatrix_test_4.md | Removed YAML metadata and revised the example description |
| docs/docs-api/MassMatrix/examples/MassMatrix_test_4.F90 | Cleared redundant metadata, streamlined code comments |
| docs/docs-api/MassMatrix/examples/MassMatrix_test_3.md | Removed outdated metadata and simplified example formatting |
| docs/docs-api/MassMatrix/examples/MassMatrix_test_3.F90 | Simplified code examples and updated comment style |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request focuses on simplifying and improving the readability of documentation and code examples related to the
MassMatrixfunctionality. The changes primarily involve the removal of Markdown-style annotations and the restructuring of code comments for better clarity. Additionally, some minor refactoring has been performed in the code examples to enhance consistency.Documentation Cleanup and Simplification:
!!! note,!!! warning) fromdocs/docs-api/MassMatrix/examples/MassMatrix_test_3.F90,MassMatrix_test_4.F90,MassMatrix_test_3.md, andMassMatrix_test_4.md. Comments have been converted to standard Fortran-style comments for better integration with the code. [1] [2] [3] [4]Code Example Improvements:
PROGRAM mainforMassMatrix_test_3.F90andMassMatrix_test_4.F90. Fortran-style comments now replace Markdown annotations, improving readability and consistency. [1] [2]MassMatrixinvocation in_MassMatrix_test_1.F90and_MassMatrix_test_2.F90to ensure consistent naming conventions and parameter usage. Added aMassMatrix_Methodimport in_MassMatrix_test_1.F90. [1] [2] [3] [4]Mathematical Notation Adjustments:
ReferenceLine_,QuadraturePoint_) to use plain text instead of Markdown-style links for clarity inMassMatrix_test_3.mdandMassMatrix_test_4.md. [1] [2]These changes collectively improve the documentation and code examples, making them more accessible to developers and users.