[WIP] Beautification and docs #127
Merged
Conversation
This file contains 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
Member
szabo137
commented
Sep 30, 2024
•
szabo137
commented
- Fix jldoctests
- finish API reference
- Write tutorial for PSP
- Write tutorial for stateful particles
- Write tutorial for Lorentz vectors
- Write tutorial for particle interface
- Write tutorial for processes
|
Looking at the documentation of the propagator, it seems outdated. It says the mass of the particle is assumed to be zero if it is not given, but |
|
Since there is not much to say about models (at least not currently), I removed the respective (blank) tutorial page. Similarly, I removed the respective pages for Dirac tensors, because there is not really an interface to talk about. I suggest explaining the Dirac algebra in QEDcore, where it is fully implemented. From my side, I think this reached a state, where we can consider merging it. |
1 task
added 18 commits
October 14, 2024 14:51
szabo137
force-pushed
the
beautification
branch
from
c05a2b1 to
8a291c8
Compare
AntonReinhard
approved these changes
Oct 21, 2024
szabo137
added a commit
to QEDjl-project/QEDcore.jl
that referenced
this pull request
Oct 22, 2024
In the same spirit as the respective [QEDbase PR](QEDjl-project/QEDbase.jl#127), this adds some documentation, orders the functions into a (hopefully more useful) library category, and adds some manuals for the main features with usage examples. - [x] Once the QEDbase PR is merged, the @extref in particles.jl has to be enabled. The vectors manual is currently more of a place holder because I don't know enough about them to write a good manual. I would refer this task to @szabo137 or @steindev . The phase space definition manual is also a placeholder, because it will be reworked soon anyway (see #50).
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.