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

provide definitions for various WDL concepts #195

Open
a-frantz opened this issue Sep 27, 2024 · 0 comments
Open

provide definitions for various WDL concepts #195

a-frantz opened this issue Sep 27, 2024 · 0 comments

Comments

@a-frantz
Copy link
Member

Tangentially related to #173

I'm reworking our preamble checks (in #187 ) and have found myself writing a very verbose explanation() for the PreambleFormatting rule. It's so long because it contains definitions for both lint directives and preamble comments, which are concepts that need to be understood to make sense of our preamble formatting. But these definitions shouldn't "live" within this explanation() text long term. There has to be a better place to put them and then we can link to them. However I'm a little stumped as to where that is.

This would be easier to solve if we had a website set up. Perhaps. Maybe not, because we want the website to be built from the Rust source, so that might not solve much.

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

No branches or pull requests

1 participant