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.

Sign up for GitHub

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

Jump to bottom

Move particle definitions from QEDprocesses.jl to QEDbase.jl #25

Merged
merged 9 commits into from
Oct 10, 2023
Merged

Move particle definitions from QEDprocesses.jl to QEDbase.jl #25

merged 9 commits into from
Oct 10, 2023

Conversation

AntonReinhard
Copy link
Member

No description provided.

@AntonReinhard AntonReinhard added the 05 - Enhancement Improvements of existing code label Oct 6, 2023
@AntonReinhard AntonReinhard marked this pull request as ready for review October 6, 2023 15:19
@AntonReinhard AntonReinhard mentioned this pull request Oct 8, 2023
Closed
szabo137
szabo137 reviewed Oct 9, 2023
View reviewed changes
Copy link
Member

@szabo137 szabo137 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Mostly minor things.

src/particles/particle_spin_pol.jl Outdated Show resolved Hide resolved
src/particles/particle_spin_pol.jl Outdated Show resolved Hide resolved
src/particles/particle_spin_pol.jl Outdated Show resolved Hide resolved
src/particles/particle_spin_pol.jl Outdated Show resolved Hide resolved
src/particles/particle_spin_pol.jl Outdated Show resolved Hide resolved
src/particles/particle_states.jl Outdated Show resolved Hide resolved
src/particles/particle_states.jl Outdated Show resolved Hide resolved
src/particles/particle_types.jl Outdated Show resolved Hide resolved
src/particles.jl Outdated Show resolved Hide resolved
src/QEDbase.jl Outdated Show resolved Hide resolved
@szabo137 szabo137 mentioned this pull request Oct 9, 2023
Merged
4 tasks
@szabo137
Copy link
Member

szabo137 commented Oct 9, 2023 •
edited
Loading

From my side, everything is fine. @steindev, @tjungni could you please have a quick look on that, so I can merge it 😃

@szabo137
Copy link
Member

@AntonReinhard could you please rebase to the latest dev. This should trigger the formatter action.

@szabo137
Copy link
Member

@SimeonEhrig The formatter works like charm 😸

tjungni
tjungni approved these changes Oct 10, 2023
View reviewed changes
Copy link
Member

@tjungni tjungni left a comment

Choose a reason for hiding this comment

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

Ready to merge

@tjungni tjungni merged commit aa78a7d into QEDjl-project:dev Oct 10, 2023
steindev
steindev reviewed Oct 11, 2023
View reviewed changes
Copy link
Member

@steindev steindev left a comment

Choose a reason for hiding this comment

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

I have a few questions and comments left.

src/particles/particle_direction.jl
!!! note "ParticleDirection Interface"
Besides being a subtype of [`ParticleDirection`](@ref), `Incoming` has

```julia
Copy link
Member

Choose a reason for hiding this comment

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

Why is there duplication of the implementation in the documentation?

Copy link
Member Author

Choose a reason for hiding this comment

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

That's true, might be better to just @Ref the functions instead.

src/particles/particle_spin_pol.jl
"""
function _spin_index(::AbstractDefiniteSpin) end
_spin_index(::SpinUp) = 1
_spin_index(::SpinDown) = 2
Copy link
Member

Choose a reason for hiding this comment

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

Weird!

Copy link
Member Author

Choose a reason for hiding this comment

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

The reason this exists is explained in the comment, it is not exported, and Uwe has already said he will look at this again at a later date.

Copy link
Member

Choose a reason for hiding this comment

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

Well, I actually meant that from my point of view SpinDown=2 is the most abstruse definition one could have come up with. But never mind. I guess there are reasons that I just don't know.

src/particles/particle_spin_pol.jl
true
```
"""
struct PolarizationX <: AbstractDefinitePolarization end
Copy link
Member

Choose a reason for hiding this comment

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

Wasn't this supposed to be called Polarization1?

Copy link
Member Author

Choose a reason for hiding this comment

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

Was it? @szabo137

src/particles/particle_states.jl Show resolved Hide resolved
src/particles/particle_states.jl Show resolved Hide resolved
src/particles/particle_types.jl
"""
Abstract base type for fermions as distinct from [`AntiFermion`](@ref)s.

!!! note "particle interface"
Copy link
Member

Choose a reason for hiding this comment

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

Again, is it necessary to duplicate the actual implementation here?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think these comments are somewhat helpful, it's just that yes, the implementations are so short that the documentation will be equal to the implementation.
Thoughts @szabo137 ?

This was referenced Oct 11, 2023
Open
Closed
Closed
@AntonReinhard AntonReinhard deleted the particles branch October 11, 2023 13:25
AntonReinhard pushed a commit to AntonReinhard/QEDbase.jl that referenced this pull request Oct 11, 2023
Belated review fixes of QEDjl-project#25
2224f3a
@AntonReinhard AntonReinhard mentioned this pull request Oct 11, 2023
Merged
@SimeonEhrig SimeonEhrig mentioned this pull request Oct 12, 2023
Closed
AntonReinhard pushed a commit that referenced this pull request Oct 13, 2023
Belated review fixes on #25 (#34)
39e0ba7 
See after-merge comments on #25
@SimeonEhrig SimeonEhrig added this to the 0.1.5 milestone Oct 18, 2023
szabo137 added a commit that referenced this pull request Jan 28, 2024
@AntonReinhard @szabo137 @tjungni
Move particle definitions from QEDprocesses.jl to QEDbase.jl (#25)
2c00514 
Co-authored-by: Anton Reinhard <[email protected]>
Co-authored-by: AntonReinhard <[email protected]>
Co-authored-by: Uwe Hernandez Acosta <[email protected]>
Co-authored-by: Tom Jungnickel <[email protected]>
@AntonReinhard AntonReinhard mentioned this pull request Jun 21, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@steindev steindev steindev left review comments

@szabo137 szabo137 szabo137 left review comments

@tjungni tjungni tjungni approved these changes

Assignees
No one assigned
Labels
05 - Enhancement Improvements of existing code
Projects
None yet
Milestone
Release-0.1.5
Development

Successfully merging this pull request may close these issues.
5 participants
@AntonReinhard @szabo137 @steindev @tjungni @SimeonEhrig