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

Add syntax for Judoc blocks #2102

Merged
merged 12 commits into from
May 19, 2023
Merged

Conversation

janmasrovira
Copy link
Collaborator

@janmasrovira janmasrovira commented May 16, 2023

This pr adds the possibility to give judoc documentation in blocks delimited by {-- and --}.

  • Inside these blocks, normal comments are disabled.
  • It is allowed to have multiple blocks associated with the same identifier, e.g.
{-- an axiom --}
{-- of type ;Type; --}
axiom a : Type;
  • Nested blocks are not allowed.
  • Blocks can be empty: {-- --}.
  • The formatter respects line breaks inside blocks.
  • The formatter normalizes whitespace at both ends of the block to a single whitespace.

@janmasrovira janmasrovira added this to the 0.3.4 milestone May 16, 2023
@janmasrovira janmasrovira self-assigned this May 16, 2023
@janmasrovira janmasrovira linked an issue May 16, 2023 that may be closed by this pull request
@janmasrovira janmasrovira force-pushed the 2050-support-block-judoc-comments branch from ee68e3a to d199584 Compare May 17, 2023 09:09
@janmasrovira janmasrovira added the enhancement New feature or request label May 19, 2023
@janmasrovira janmasrovira marked this pull request as ready for review May 19, 2023 09:00
@jonaprieto jonaprieto self-requested a review May 19, 2023 11:01
@jonaprieto jonaprieto force-pushed the 2050-support-block-judoc-comments branch from 1f86bbd to d814224 Compare May 19, 2023 11:24
@jonaprieto jonaprieto merged commit 9b1011b into main May 19, 2023
@jonaprieto jonaprieto deleted the 2050-support-block-judoc-comments branch May 19, 2023 12:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request syntax
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support block judoc comments
2 participants