search

QEDjl-project / QEDprocesses.jl

[WIP]: QEDprocesses.jl: Modeling of scattering processes for QED.jl
https://qedjl-project.github.io/QEDprocesses.jl/stable/
MIT License
1 stars 3 forks source link

add document build and deploy jobs #19

Closed SimeonEhrig closed 11 months ago

SimeonEhrig commented 11 months ago

solves #10

Copy of: https://github.com/QEDjl-project/QEDevents.jl/pull/10

SimeonEhrig commented 11 months ago

@szabo137 Do you know, why the job fails? https://github.com/QEDjl-project/QEDprocesses.jl/actions/runs/6467150725/job/17556628908?pr=19

szabo137 commented 11 months ago

I will look into this. I assume some API change in Documenter.jl.

SimeonEhrig commented 11 months ago

I will look into this. I assume some API change in Documenter.jl.

Looks like this line of code causes the problem: https://github.com/QEDjl-project/QEDprocesses.jl/blob/0074aa02285d5ef39e63f5a204e02ac4b5b1f6d8/src/interfaces/setup_interface.jl#L101

SimeonEhrig commented 11 months ago

I will look into this. I assume some API change in Documenter.jl.

Looks like this line of code causes the problem:

https://github.com/QEDjl-project/QEDprocesses.jl/blob/0074aa02285d5ef39e63f5a204e02ac4b5b1f6d8/src/interfaces/setup_interface.jl#L101

@szabo137 Looks like, the documentation references an error type, which does not exist. I didn't found anything in the QED projects and also not in the official documentation.

AntonReinhard commented 11 months ago

It should be AbstractInvalidInputException, that's what is defined. But it is a little weird that one is SomethingException and the other is SomethingError, so we should probably use one of the two consistently everywhere. I think I would prefer Exception, Error is less specific.

So I'd suggest renaming the InvalidInputError to InvalidInputException, too.

SimeonEhrig commented 11 months ago

It should be AbstractInvalidInputException, that's what is defined. But it is a little weird that one is SomethingException and the other is SomethingError, so we should probably use one of the two consistently everywhere. I think I would prefer Exception, Error is less specific.

So I'd suggest renaming the InvalidInputError to InvalidInputException, too.

Yes, you are right. We are a little bit inconsistent :sweat_smile:

https://github.com/QEDjl-project/QEDprocesses.jl/blob/0074aa02285d5ef39e63f5a204e02ac4b5b1f6d8/src/interfaces/setup_interface.jl#L79-L83

Nevertheless, I would fix the error in the documentation now and we do the possible renaming in an extra PR.