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

feat: init wdl-doc #248

Merged
merged 22 commits into from
Dec 10, 2024
Merged

feat: init wdl-doc #248

merged 22 commits into from
Dec 10, 2024

Conversation

a-frantz
Copy link
Member

@a-frantz a-frantz commented Nov 5, 2024

Describe the problem or feature in addition to a link to the issues.

This is a very rough init commit for wdl-doc. All the current HTML output is going to be thrown out and reimplemented once we have the templates from the designers, so I wouldn't spend much time combing through that with a fine-tooth comb.

The most important bit included in this PR is the resulting output directory structure created in wdl-doc/src/lib.rs.

Before submitting this PR, please make sure:

  • You have added a few sentences describing the PR here.
  • You have added yourself or the appropriate individual as the assignee.
  • You have added at least one relevant code reviewer to the PR.
  • Your code builds clean without any errors or warnings.
  • You have added tests (when appropriate).
  • You have updated the README or other documentation to account for these
    changes (when appropriate).
  • You have added an entry to the relevant CHANGELOG.md (see
    "keep a changelog" for more information).
  • Your commit messages follow the conventional commit style.

@a-frantz a-frantz self-assigned this Nov 5, 2024
@a-frantz a-frantz changed the title feat: wdl-doc feat: init wdl-doc Dec 6, 2024
@a-frantz a-frantz marked this pull request as ready for review December 9, 2024 18:33
wdl-doc/src/lib.rs Outdated Show resolved Hide resolved
wdl-doc/src/lib.rs Outdated Show resolved Hide resolved
wdl-doc/src/lib.rs Outdated Show resolved Hide resolved
@a-frantz a-frantz requested a review from adthrasher December 10, 2024 15:12
Copy link
Collaborator

@peterhuene peterhuene left a comment

Choose a reason for hiding this comment

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

Looks great, just some nit picky comments.

wdl-doc/src/struct.rs Outdated Show resolved Hide resolved
wdl-doc/src/struct.rs Outdated Show resolved Hide resolved
Co-authored-by: Peter Huene <peter@huene.dev>
wdl-doc/src/struct.rs Outdated Show resolved Hide resolved
>&2 echo "But number must be less than 4096!"
exit 42
fi
elif [[ "~{number}" =~ ^0[0-7]{0,4}$ ]] \
Copy link
Member

Choose a reason for hiding this comment

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

Just a thought for the future—it may be worth pulling in the St. Jude Cloud workflows as a submodule here for a more complete picture.

wdl/src/bin/wdl.rs Outdated Show resolved Hide resolved
Copy link
Member

@claymcleod claymcleod left a comment

Choose a reason for hiding this comment

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

Good after these.

@a-frantz a-frantz merged commit c92e353 into main Dec 10, 2024
16 checks passed
@a-frantz a-frantz deleted the feat/wdl-doc branch December 10, 2024 22:33
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.

4 participants