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

Improve Docs for new Users #1911

Merged
merged 3 commits into from
Apr 23, 2024
Merged

Conversation

DanielDoehring
Copy link
Contributor

This aims to tackle some of the feedback from #1907.

In particular, I seek to address

  1. This overview however does not mention which type of fluxes (i.e. dispatching on normals or integer directions) are needed for which grid

  2. Similarly, links [...] for the Structured Mesh to the "Structured mesh with curvilinear mapping" would also be helpful

  3. Finally, I haven't seen it explicitly mentioned that TreeMesh makes the domain square?

@DanielDoehring DanielDoehring added the documentation Improvements or additions to documentation label Apr 23, 2024
Copy link
Contributor

Review checklist

This checklist is meant to assist creators of PRs (to let them know what reviewers will typically look for) and reviewers (to guide them in a structured review process). Items do not need to be checked explicitly for a PR to be eligible for merging.

Purpose and scope

  • The PR has a single goal that is clear from the PR title and/or description.
  • All code changes represent a single set of modifications that logically belong together.
  • No more than 500 lines of code are changed or there is no obvious way to split the PR into multiple PRs.

Code quality

  • The code can be understood easily.
  • Newly introduced names for variables etc. are self-descriptive and consistent with existing naming conventions.
  • There are no redundancies that can be removed by simple modularization/refactoring.
  • There are no leftover debug statements or commented code sections.
  • The code adheres to our conventions and style guide, and to the Julia guidelines.

Documentation

  • New functions and types are documented with a docstring or top-level comment.
  • Relevant publications are referenced in docstrings (see example for formatting).
  • Inline comments are used to document longer or unusual code sections.
  • Comments describe intent ("why?") and not just functionality ("what?").
  • If the PR introduces a significant change or new feature, it is documented in NEWS.md.

Testing

  • The PR passes all tests.
  • New or modified lines of code are covered by tests.
  • New or modified tests run in less then 10 seconds.

Performance

  • There are no type instabilities or memory allocations in performance-critical parts.
  • If the PR intent is to improve performance, before/after time measurements are posted in the PR.

Verification

  • The correctness of the code was verified using appropriate tests.
  • If new equations/methods are added, a convergence test has been run and the results
    are posted in the PR.

Created with ❤️ by the Trixi.jl community.

Copy link
Member

@sloede sloede left a comment

Choose a reason for hiding this comment

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

LGTM except for a small typo. It would be great to get some feedback from @knstmrd as well though!

docs/src/overview.md Outdated Show resolved Hide resolved
@knstmrd
Copy link

knstmrd commented Apr 23, 2024

Looks good to me! Thanks!

Co-authored-by: Michael Schlottke-Lakemper <[email protected]>
@sloede sloede merged commit 34b1b1e into trixi-framework:main Apr 23, 2024
6 checks passed
@DanielDoehring DanielDoehring deleted the ImproveDocs branch April 23, 2024 12:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants