Skip to content

Update the representation of code blocks #711

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

Closed
wants to merge 2 commits into from

Conversation

Julow
Copy link
Collaborator

@Julow Julow commented Aug 3, 2021

The representation of code blocks will change slightly: ocaml-doc/odoc-parser#2
This doesn't make use of the language tag yet.

@Julow Julow marked this pull request as draft August 3, 2021 19:23
@@ -40,7 +40,9 @@ type module_reference = {

type nestable_block_element =
[ `Paragraph of paragraph
| `Code_block of string with_location option * string with_location
| `Code_block of
string with_location option * string with_location
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The meaning of the first argument changed (from the whole metadata to just the language tag) but it wasn't used anywhere.

Copy link
Contributor

Choose a reason for hiding this comment

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

I suggest turning it into a (new) record type.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good idea :)

The representation of code blocks will change slightly.
This doesn't make use of the language tag yet.
This needs to be reverted once odoc-parser is released.
@Julow
Copy link
Collaborator Author

Julow commented Sep 30, 2021

We don't need to interpret that field yet. We don't need this for compatibility either: #742

@Julow Julow closed this Sep 30, 2021
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.

2 participants