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.

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

add document build and deploy jobs #19

Merged
merged 1 commit into from
Oct 16, 2023

Conversation

SimeonEhrig
Copy link
Member

@SimeonEhrig SimeonEhrig commented Oct 10, 2023

@SimeonEhrig
Copy link
Member Author

@szabo137
Copy link
Member

szabo137 commented Oct 10, 2023

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

@SimeonEhrig
Copy link
Member Author

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

Looks like this line of code causes the problem:

which should throw an exception, which is a subtype of [`AbstractInvalidInputError`](@ref). One may also use the concrete implementation [`InvalidInputError`](@ref) if the input is invalid instead of writing a custom exception type.

@SimeonEhrig
Copy link
Member Author

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

Looks like this line of code causes the problem:

which should throw an exception, which is a subtype of [`AbstractInvalidInputError`](@ref). One may also use the concrete implementation [`InvalidInputError`](@ref) if the input is invalid instead of writing a custom exception type.

@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
Copy link
Member

AntonReinhard commented Oct 11, 2023

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
Copy link
Member Author

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 😅

Exception which is thrown if a given input is invalid, e.g. passed to [`_assert_valid_input`](@ref).
"""
struct InvalidInputError <: AbstractInvalidInputException
msg::String
end

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

Copy link
Member

@szabo137 szabo137 left a comment

Choose a reason for hiding this comment

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

Nothing to bother, merging!

@szabo137 szabo137 merged commit 84cbe11 into QEDjl-project:dev Oct 16, 2023
2 checks passed
@szabo137 szabo137 added this to the Release 0.1.0 milestone Oct 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants