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

Provide document of numeric types and type stability #1938

Merged
merged 13 commits into from
May 15, 2024

Conversation

huiyuxie
Copy link
Member

Covers #1909. It is just a start and later I will add more documentation.

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 with its PR number.

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.

@huiyuxie huiyuxie self-assigned this May 10, 2024
@huiyuxie huiyuxie added the documentation Improvements or additions to documentation label May 10, 2024
@huiyuxie huiyuxie requested a review from ranocha May 10, 2024 03:26
Copy link
Member

@ranocha ranocha left a comment

Choose a reason for hiding this comment

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

Thanks.

docs/src/conventions.md Outdated Show resolved Hide resolved
@huiyuxie huiyuxie changed the title Provide document of new numerical support (Float32) Provide document of numerical support (Float64 and Float32) May 10, 2024
@huiyuxie huiyuxie changed the title Provide document of numerical support (Float64 and Float32) Provide document of numeric types and type stability May 10, 2024
@huiyuxie huiyuxie requested a review from ranocha May 10, 2024 21:13
@huiyuxie
Copy link
Member Author

Please check again now :)

First, please check style, I try to keep consistency with the rest of the convention file. Second, concerning content, I think handling these cases on a case-by-case basis is acceptable for now (but I have no idea if this is good for other developers). Third, I suggest asking someone unfamiliar with these things to review it again. While you understand it clearly, it may not be as easy for others to grasp.

docs/src/conventions.md Outdated Show resolved Hide resolved
docs/src/conventions.md Outdated Show resolved Hide resolved
docs/src/conventions.md Outdated Show resolved Hide resolved
@huiyuxie huiyuxie requested a review from ranocha May 14, 2024 01:26
@huiyuxie
Copy link
Member Author

huiyuxie commented May 14, 2024

Shall we merge this PR if it looks good to you, or should it be held until the main PR is ready to merge?

I think I should check the main PR again based on your provided notes. Please wait

@ranocha ranocha removed their request for review May 14, 2024 05:15
ranocha
ranocha previously approved these changes May 14, 2024
Copy link
Member

@ranocha ranocha left a comment

Choose a reason for hiding this comment

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

Thanks! This looks good to me. It would be nice to get feedback from @sloede next. Then, we can merge this PR and continue with the other ones.

@ranocha ranocha requested a review from sloede May 14, 2024 05:20
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.

Thanks a lot for adding this to the docs! I only have some small suggestions for adding additional context, plus some formatting changes (I'd use proper subheadings such that we can directly link to them)

docs/src/conventions.md Outdated Show resolved Hide resolved
docs/src/conventions.md Outdated Show resolved Hide resolved
docs/src/conventions.md Outdated Show resolved Hide resolved
docs/src/conventions.md Outdated Show resolved Hide resolved
docs/src/conventions.md Outdated Show resolved Hide resolved
docs/src/conventions.md Outdated Show resolved Hide resolved
Co-authored-by: Michael Schlottke-Lakemper <[email protected]>
@huiyuxie huiyuxie requested a review from ranocha May 14, 2024 20:36
@huiyuxie huiyuxie requested a review from sloede May 14, 2024 20:36
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.

Thanks for bearing with me @huiyuxie! I've made a new suggestion, where I leave your original part about exact FP values virtually unchanged, but add some clarification later.

Once these final remarks are resolved, this is ready to merge 😊

docs/src/conventions.md Outdated Show resolved Hide resolved
docs/src/conventions.md Show resolved Hide resolved
Co-authored-by: Michael Schlottke-Lakemper <[email protected]>
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.

Thanks!

@huiyuxie
Copy link
Member Author

Thanks, these are good suggestions!

Copy link
Member

@ranocha ranocha left a comment

Choose a reason for hiding this comment

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

Thanks!

@ranocha ranocha merged commit 3d0cc8d into trixi-framework:main May 15, 2024
6 checks passed
@huiyuxie huiyuxie deleted the docs branch May 17, 2024 20:41
@huiyuxie huiyuxie restored the docs branch May 17, 2024 20:51
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