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

Remove abusive normalization in docstrings references #2159

Closed
wants to merge 2 commits into from

Conversation

EmileTrotignon
Copy link
Collaborator

This fixes the following failure : formatting (** {! refref [ } *) into (** {! refref \[ } *)

Merge branch 'main' of github.com:ocaml-ppx/ocamlformat
@facebook-github-bot
Copy link

Hi @EmileTrotignon!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

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.

Looks good to me :) For context, this goes with ocaml-doc/odoc-parser#12.

The CI is failing because the test test/failing/tests/unstable_docstrings.mli was expecting this reference to be escaped in the middle: {!serve_with_handler]/{!serve}}. I think the whole test can be removed.

@gpetiot
Copy link
Collaborator

gpetiot commented Sep 21, 2022

The CI is failing because the test test/failing/tests/unstable_docstrings.mli was expecting this reference to be escaped in the middle: {!serve_with_handler]/{!serve}}. I think the whole test can be removed.

Should this error be handled by odoc-parser instead? If not we can move the test from failing/ to passing/

@Julow
Copy link
Collaborator

Julow commented Sep 21, 2022

Adding such a test to passing/ would be nice but only the interesting part: A reference that contains [] and {}. The rest doesn't seem useful.

There's no error from the pov of odoc-parser.

@facebook-github-bot
Copy link

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

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