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

Reduce tutorial mdoc noise #603

Merged
merged 1 commit into from
Jul 31, 2024
Merged

Reduce tutorial mdoc noise #603

merged 1 commit into from
Jul 31, 2024

Conversation

valencik
Copy link
Member

Current there is duplication / noise in the mdoc output from hardcoded result comments:

Screenshot 2024-07-30 at 10 08 15 PM

This PR removes these comments as mdoc computes and displays them for us.

@johnynek
Copy link
Collaborator

I think without seeing the output, those examples don't really work. There are now just a lot of calls to .parse. What are they returning?

It isn't clear.

If we do this, we should add some asserts or something so people can understand if the parse succeeds or fails.

@valencik
Copy link
Member Author

Hey Oscar, that's for taking a look at this :)

Just to be clear, the output will still appear on the site, mdoc executes the code and inserts the results with their types in the final output.
This PR is just removing the additional "manual" result line comments, which are not type checked by mdoc, and add extra noise to the site output.

Here's a Before and After screenshot:

Before
cats-parse-before

After
cats-parse-after

This is also nice because mdoc is a bit more clear in how it prints some output.
Compare mdoc's Right(value = ("", 't')) to the prior manual annotation Right((,t))

@johnynek
Copy link
Collaborator

got it, thanks for clarifying.

@johnynek johnynek merged commit 5f0a639 into typelevel:main Jul 31, 2024
13 checks passed
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