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

Added documentation for the Markdown Macro #52607

Merged
merged 4 commits into from
Feb 7, 2024

Conversation

mokshablr
Copy link
Contributor

Added documentation for the md_str() macro which is used by md"".
Mentioned in #51168.

@mokshablr
Copy link
Contributor Author

I would love to help fixing the failed tests with some help. I'm still very new to contributing to projects so I don't quite understand why these tests are failing.

@mitiemann
Copy link
Contributor

I would love to help fixing the failed tests with some help. I'm still very new to contributing to projects so I don't quite understand why these tests are failing.

The build system fails as some formatting tests are not passing. I'm guessing there are some undesired blank lines? What output does make check-whitespace generate?

However, is there a particular reason why you've wanted to create your own PR instead of contributing to #52606 ?

@mokshablr
Copy link
Contributor Author

The build system fails as some formatting tests are not passing. I'm guessing there are some undesired blank lines? What output does make check-whitespace generate?

Whitespace check found 1 issues:
stdlib/Markdown/docs/src/index.md:409 -- no trailing newline
make: *** [check-whitespace] Error 1

However, is there a particular reason why you've wanted to create your own PR instead of contributing to #52606 ?

When I started working on this issue there was no PR relating to this. Looks like it was made a few minutes before I made mine.

@mitiemann
Copy link
Contributor

Whitespace check found 1 issues:
stdlib/Markdown/docs/src/index.md:409 -- no trailing newline
make: *** [check-whitespace] Error 1

This means that you need to add one newline at the end of the file.

However, is there a particular reason why you've wanted to create your own PR instead of contributing to #52606 ?

When I started working on this issue there was no PR relating to this. Looks like it was made a few minutes before I made mine.

Funny coincidence :-) So, which of the two PRs should we complete? I'd personally would like to keep the added docstring for the macro in the source file, but I don't have strong opinions how the docs/index.md should look like.

@mokshablr
Copy link
Contributor Author

This means that you need to add one newline at the end of the file.
I removed the newline since I had got this error when it existed. Not quite sure what it expects from me.

Whitespace check found 1 issues:
stdlib/Markdown/docs/src/index.md:410 -- trailing blank lines
make: *** [check-whitespace] Error 1

Funny coincidence :-) So, which of the two PRs should we complete? I'd personally would like to keep the added docstring for the macro in the source file, but I don't have strong opinions how the docs/index.md should look like.

We could have 2 seperate PRs maybe? Yours for the docstring and mine for the docs/index.md? Again, not sure if this is how it works here since I'm new to contributing.

@mitiemann
Copy link
Contributor

It seems you've gone from "no newline at end of file" to "too many newlines at end of file". The enforced style is "the last line with content should have another newline character, but then, there should be no more empty lines". Hope this helps.

As for the communal aspect: this is also my very first contribution to Julia, so I'm also unaware of these guidelines. I guess we'll just have to wait what the moderators say. However, if you want to, I could give you write access to my fork (or vice versa) and we could converge in one PR. Maybe that would make it easier for the mods as well?

@vtjnash vtjnash marked this pull request as ready for review February 6, 2024 22:01
@vtjnash vtjnash added docs This change adds or pertains to documentation merge me PR is reviewed. Merge when all tests are passing labels Feb 6, 2024
@inkydragon inkydragon merged commit d765ad1 into JuliaLang:master Feb 7, 2024
9 checks passed
@inkydragon inkydragon removed the merge me PR is reviewed. Merge when all tests are passing label Feb 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants