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

Check freshness of doc/stdlib on Travis #18815

Closed
wants to merge 2 commits into from
Closed

Conversation

martinholters
Copy link
Member

Will be obsoleted by #18588 but hopefully is useful until then by catching the common mistake of modifying docstrings and not updating the corresponding RST files.

@martinholters
Copy link
Member Author

The error this has found immediately has been fixed in 38a63bd (38a63bd#diff-1b93b2bd585f1eb42df445590f059fdcR1643).

@tkelman
Copy link
Contributor

tkelman commented Oct 7, 2016

It's a little too easy to miss why the build failed here. Should probably terminate the job immediately and not run the tests when this happens.

@martinholters
Copy link
Member Author

Hm, I couldn't find a way to make Travis terminate the job. Doing this test last might be a viable alternative.

@kshyatt kshyatt added docsystem The documentation building system testsystem The unit testing framework and Test stdlib labels Oct 7, 2016
@tkelman
Copy link
Contributor

tkelman commented Oct 11, 2016

Waiting until the very end to run this is going to eat up a lot of CI time. Simple, not especially elegant workaround would be to touch a file as a flag if this check succeeds, and skip running the tests to save CI time (but still flag the build as a failure) if it's not present.

@martinholters
Copy link
Member Author

I had something like that using an environment variable, similar to test $STDLIBDOCCHECK_RESULT || ... in front of the test runner, but the output was still so noisy that the actual output of the stdlib doc test was easy to miss. However, doing something like that and producing clearly visible output at the end might work. Will try next...

@martinholters
Copy link
Member Author

Comments on the current status?

@kshyatt
Copy link
Contributor

kshyatt commented Oct 25, 2016

Bumping.

@martinholters
Copy link
Member Author

Bump.

@tkelman
Copy link
Contributor

tkelman commented Nov 3, 2016

I think #18588 is close enough to merging that this is soon to be made obsolete. This yml file is already pretty complicated and hard to read as is.

@martinholters
Copy link
Member Author

Fair enough. I'll leave this open for now in case some unexpected problem comes up in #18588.

@martinholters
Copy link
Member Author

Superseded by #18588.

@martinholters martinholters deleted the mh/checkdocs branch December 8, 2016 08:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docsystem The documentation building system testsystem The unit testing framework and Test stdlib
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants