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

Fix doctest_fix for Documenter 1.0 #2852

Merged
merged 1 commit into from
Sep 26, 2023

Conversation

fingolfin
Copy link
Member

No description provided.

Copy link
Member

@lgoettgens lgoettgens left a comment

Choose a reason for hiding this comment

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

LGTM, one comment below you are free to ignore.

Comment on lines +83 to +87
if isdefined(Main.Documenter, :DocTests)
doctest = Main.Documenter.DocTests.doctest
else
doctest = Main.Documenter._doctest
end
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
if isdefined(Main.Documenter, :DocTests)
doctest = Main.Documenter.DocTests.doctest
else
doctest = Main.Documenter._doctest
end
if isdefined(Main.Documenter, :_doctest)
doctest = Main.Documenter._doctest
else
doctest = Main.Documenter.DocTests.doctest
end

I would be more inclined to switch up the order, such that the Documenter 1.0 version is the first one. This makes the future dropping of 0.27 support clearer and more readable.

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 don't agree that it is clearer, one still has to know which version is what. If we want this to be "clear" we need to switch this and other existing checks to check for a version. But that seems to be investing 5 minutes of work now to save 5 minutes of work later, so IMHO not worth it :-)

Copy link
Member

Choose a reason for hiding this comment

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

True :)

@codecov
Copy link

codecov bot commented Sep 25, 2023

Codecov Report

Merging #2852 (7b909e0) into master (1a11d14) will decrease coverage by 0.02%.
Report is 1 commits behind head on master.
The diff coverage is 0.00%.

@@            Coverage Diff             @@
##           master    #2852      +/-   ##
==========================================
- Coverage   80.67%   80.65%   -0.02%     
==========================================
  Files         456      456              
  Lines       64717    64720       +3     
==========================================
- Hits        52208    52203       -5     
- Misses      12509    12517       +8     
Files Changed Coverage
src/utils/docs.jl 0.00%

@fingolfin fingolfin merged commit add39f2 into oscar-system:master Sep 26, 2023
13 of 15 checks passed
@fingolfin fingolfin deleted the mh/fix-doctest_fix branch September 26, 2023 08:08
fieker pushed a commit that referenced this pull request Sep 29, 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.

2 participants