Documentation and Manuals #69
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
szabo137
previously approved these changes
Oct 11, 2024
AntonReinhard
force-pushed
the
documentation
branch
from
9a59c6f to
3c3aacf
Compare
szabo137
previously approved these changes
Oct 21, 2024
AntonReinhard
force-pushed
the
documentation
branch
from
dacfa11 to
6d840ae
Compare
AntonReinhard
force-pushed
the
documentation
branch
from
6d840ae to
cf5f65d
Compare
|
This has one temporary docstring from the QEDbase_patch.jl which I'll remove in a separate PR when the patch is remove. |
Merged
szabo137
approved these changes
Oct 22, 2024
SimeonEhrig
pushed a commit
that referenced
this pull request
Oct 23, 2024
Merge after #69 This deletes the QEDbase patch which is no longer necessary as the relevant PR in QEDbase was merged. Unfortunately, there seems to be a somewhat strange interaction of doubly defined typenames and `@reexport`, creating an issue in QEDbase's documentation building. This means that I had to remove some `@extref` statements for now that can be readded later, when QEDbase is ready.
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.
In the same spirit as the respective QEDbase PR, 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.
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).