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

Implicitly ended tags. #1239

Merged
merged 6 commits into from
Nov 13, 2024
Merged

Implicitly ended tags. #1239

merged 6 commits into from
Nov 13, 2024

Conversation

panglesd
Copy link
Collaborator

@panglesd panglesd commented Nov 8, 2024

This is an attempt to solve #1138.

The solution I went for is to end tags implicitly, in the same way as shorthand list syntax is implicitly ended: by a new line, a header or a tag. Indeed, otherwise the implicit ending of a tag containing a shorthand list item is very unclear, see #1138 (comment).

panglesd added a commit to panglesd/odoc that referenced this pull request Nov 8, 2024
@jonludlam
Copy link
Member

s/implicitely/implicitly/g

@gpetiot gpetiot changed the title Implicitely ended tags. Implicitly ended tags. Nov 11, 2024
Copy link
Collaborator

@gpetiot gpetiot left a comment

Choose a reason for hiding this comment

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

Looks good!

They are not necessarily at the end anymore, and the end similarly as light
syntax list: on new lines or heading.

This is a breaking change, which according to ocaml#1138 is fixing more things than
breaking them.
It will allow using custom tags and tags in mld files.
Copy link
Collaborator

@Julow Julow left a comment

Choose a reason for hiding this comment

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

Tags containing a block_element_list do not end at a heading. For example, here the heading is turned into a paragraph and part of the tag:

 @deprecated foo

 {1 heading}

Is this intended ? Perhaps `After_tag in type where_in_line should be removed ?

@panglesd
Copy link
Collaborator Author

I'm not seeing the same behavior! See eg.

@jonludlam
Copy link
Member

I'm also not seeing the behaviour that @Julow observed.

I'd like to have a documentation page that describes these behaviours - including those of lists that I don't believe are documented anywhere. We need that before release, but not before we merge this PR :-)

Copy link
Collaborator

@Julow Julow left a comment

Choose a reason for hiding this comment

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

I tested it wrong, sorry!

Looks good :)

@jonludlam jonludlam merged commit 81ecc58 into ocaml:master Nov 13, 2024
13 checks passed
jonludlam pushed a commit that referenced this pull request Nov 13, 2024
@jonludlam
Copy link
Member

Thanks!

jonludlam pushed a commit to panglesd/odoc that referenced this pull request Nov 13, 2024
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