Add pretty printing for particle directions, species, and spin/pol #61
Conversation
|
To stay in accordance with https://docs.julialang.org/en/v1/manual/types/#man-custom-pretty-printing , I've now only overloaded the 3-argument show function, i.e. the one used when julia> Electron()
electron
julia> [Electron(), Positron(), Photon()]
3-element Vector{AbstractParticleType}:
electron
positron
photon
julia> print(Electron())
Electron() |
|
One question before we merge: I added QEDbase to the docs/Project.toml by simply building the docs (to check the jldoctests). Should it be in there? I'm wondering if there's a reason it wasn't before |
I think adding QEDbase to the Project.toml of the docs is correct. Currently, we use the workaround |
Adds pretty printing for: - PerturbativeQED model - Compton process - Coordinate systems, frames of reference, and phase space definition - Particle stateful - PhaseSpacePoint Essentially, adding similar functionality to QEDjl-project/QEDbase.jl#61 for the QEDprocesses types. I'm using the jldoctests to test, I'm not sure if it's really necessary to test in a separate test as well. Putting single jldoctests for these prints in every type definition would clutter the documentation a bit so I've not done that. If we really want tests for each `show()` we should probably do it in a test file. Also, I'm not sure if there's a better way for the print functions than alternating the `show` for objects and `print` for strings. Interpolating doesn't work unless we also overload the `print`. (I *think* it is print, the number of string output related functions in Julia is confusing)
Just what the title says. I want to add some pretty printing in QEDprocesses as well, and these are helpful for that. I also added jldoctests.