Skip to content

Fixing docs following breaking change #1562

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
Merged
merged 8 commits into from
Aug 28, 2021
Merged

Fixing docs following breaking change #1562

merged 8 commits into from
Aug 28, 2021

Conversation

matbesancon
Copy link
Contributor

No description provided.

@matbesancon matbesancon changed the title first take on improved docs Fixing docs following breaking change Aug 27, 2021
@matbesancon
Copy link
Contributor Author

I'm surprised some of the docstrings here did not break before, the formatting of the output was incorrect with 1.6 printing

@blegat
Copy link
Member

blegat commented Aug 27, 2021

It's still using Julia v1.0: https://github.com/jump-dev/MathOptInterface.jl/blob/master/.github/workflows/documentation.yml#L16

@matbesancon
Copy link
Contributor Author

yes I saw that. Why are we using Julia 1.0? I can understand checking the tests on a legacy version, but doctests sounds weird, this is what people will use to read, and likely more on Julia stable than 1.0.

Furthermore this means

  1. the docs will take way more time to build
  2. one needs julia 1.0 locally to build the docs

@matbesancon
Copy link
Contributor Author

I can revert the changes but am very skeptical on the interest of 1.0 here

@matbesancon
Copy link
Contributor Author

this also means that finally dropping 1.0 support will require some extra work fixing all the docstrings

matbesancon
matbesancon commented Aug 27, 2021
View reviewed changes
@blegat
Copy link
Member

blegat commented Aug 27, 2021 •
edited
Loading

Why are we using Julia 1.0?

No one took the effort to upgrade I think. I'm in favor of updating this to Julia v1.6

@odow
Copy link
Member

odow commented Aug 28, 2021

You can run with doctests=:fix to update the docs. We could do that in a separate PR.

odow
odow reviewed Aug 28, 2021
View reviewed changes
test/Utilities/model.jl
end

function _test_T
function _test_T()
Copy link
Member

Choose a reason for hiding this comment

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

Haha. I didn't consider this edge case.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Was it caused by one of the regexes I assume?

@odow odow merged commit 2db51ea into jump-dev:od/rm-SingleVariable Aug 28, 2021
odow pushed a commit that referenced this pull request Aug 31, 2021
@matbesancon @odow
Fixing docs following breaking change (#1562)
d42ef69
odow pushed a commit that referenced this pull request Aug 31, 2021
@matbesancon @odow
Fixing docs following breaking change (#1562)
2fe8862
@matbesancon matbesancon deleted the rm-singlev-doc branch August 31, 2021 14:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@odow odow odow left review comments

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@matbesancon @blegat @odow