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 preprocessing step to automate numbering in tutorial introduction #1901

Merged
merged 4 commits into from
Apr 9, 2024

Conversation

bennibolm
Copy link
Contributor

Right now, when someone wants to add a new tutorial, he has to update all following numbers within the introduction. This is done for instance in this PR.

The new preprocessing step automates the numbering.

@bennibolm bennibolm added the documentation Improvements or additions to documentation label Apr 9, 2024
Copy link
Contributor

github-actions bot commented Apr 9, 2024

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.

@bennibolm
Copy link
Contributor Author

I don't really know if this change is wanted but for me, it was annoying to update all the numbers when adding a new tutorial.
Also, the numbering within the tutorials is automatic as well using the preprocessing step from here.

@bennibolm bennibolm requested a review from sloede April 9, 2024 11:38
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.

Good idea! I've left some comments. It would also be great to get a feedback from @ArseniyKholod, since he's also been active writing tutorials...

docs/literate/src/files/index.jl Outdated Show resolved Hide resolved
docs/literate/make.jl Outdated Show resolved Hide resolved
docs/literate/make.jl Outdated Show resolved Hide resolved
@bennibolm bennibolm requested a review from ArseniyKholod April 9, 2024 13:02
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 and can be merged once @ArseniyKholod signs off as well 🙂

Thank you for the nice improvement of developer convenience 👍

Copy link
Contributor

@ArseniyKholod ArseniyKholod left a comment

Choose a reason for hiding this comment

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

Thanks! Really good idea, it was annoying to change all indexes manually. LGTM!

@bennibolm bennibolm enabled auto-merge (squash) April 9, 2024 13:41
@bennibolm
Copy link
Contributor Author

Oh, just realized (again) that auto-merge doesn't work here. Please be so nice and merge it @sloede 😄

@ranocha ranocha disabled auto-merge April 9, 2024 14:51
@ranocha ranocha merged commit efbd5a7 into trixi-framework:main Apr 9, 2024
6 checks passed
@bennibolm bennibolm deleted the preprocessing-introduction branch April 10, 2024 07:10
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.

4 participants