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

Improve WDL documentation #4711

Closed

Conversation

adamnovak
Copy link
Member

This will hopefully fix #4631.

Still missing is a substantial worked tutorial for WDL, like we have for Python. But I've re-organized the docs and changed some words around to make Toil Python less the default.

Changelog Entry

To be copied to the draft changelog by merger:

  • Warnings in the Toil documentation build (due to docstrings Sphinx can't understand) will now fail CI.
  • Docstrings have been fixed to be parseable by Sphinx.
  • The Toil documentation now emphasizes CWL and WDL usage.

Reviewer Checklist

  • Make sure it is coming from issues/XXXX-fix-the-thing in the Toil repo, or from an external repo.
    • If it is coming from an external repo, make sure to pull it in for CI with:
      contrib/admin/test-pr otheruser theirbranchname issues/XXXX-fix-the-thing
      
    • If there is no associated issue, create one.
  • Read through the code changes. Make sure that it doesn't have:
    • Addition of trailing whitespace.
    • New variable or member names in camelCase that want to be in snake_case.
    • New functions without type hints.
    • New functions or classes without informative docstrings.
    • Changes to semantics not reflected in the relevant docstrings.
    • New or changed command line options for Toil workflows that are not reflected in docs/running/{cliOptions,cwl,wdl}.rst
    • New features without tests.
  • Comment on the lines of code where problems exist with a review comment. You can shift-click the line numbers in the diff to select multiple lines.
  • Finish the review with an overall description of your opinion.

Merger Checklist

  • Make sure the PR passes tests.
  • Make sure the PR has been reviewed since its last modification. If not, review it.
  • Merge with the Github "Squash and merge" feature.
    • If there are multiple authors' commits, add Co-authored-by to give credit to all contributing authors.
  • Copy its recommended changelog entry to the Draft Changelog.
  • Append the issue number in parentheses to the changelog entry.

@adamnovak
Copy link
Member Author

I still need to add something about the conformance tests to this to fulfill the brief. I don't actually need a worked WDL tutorial probably.

@adamnovak adamnovak marked this pull request as ready for review December 15, 2023 21:34
@adamnovak
Copy link
Member Author

Looks like I accidentally made this from my fork; if we have to bump the branch we also have to put the commits on issues/4631-improve-wdl-docs in this repo to test them.

@adamnovak adamnovak closed this Jan 3, 2024
@adamnovak adamnovak mentioned this pull request Jan 3, 2024
19 tasks
@adamnovak
Copy link
Member Author

I closed this out since I needed to update it and I made it from the wrong branch anyway.

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.

Emphasize WDL and the WDL conformance tests in the documentation
1 participant