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

doc: fix confusion markdown in util.markdown #1097

Closed
wants to merge 1 commit into from
Closed

doc: fix confusion markdown in util.markdown #1097

wants to merge 1 commit into from

Conversation

yorkie
Copy link
Contributor

@yorkie yorkie commented Mar 8, 2015

Caught this one in reading the util doc, checked the doc of nodej and iojs:

But the github markdown worked at https://github.com/iojs/io.js/blob/v1.x/doc/api/util.markdown#utilformatformat-

Well, now I fixed the confusion bug on on this line, but btw, I think we should keep using the markdown parser same to github markdown, so that we needn't another review on website. I'm interested in this proposal if someone could give me the guiding link on how the website are built and working, Thank you :)

@@ -53,8 +53,7 @@ argument. Supported placeholders are:

* `%s` - String.
* `%d` - Number (both integer and float).
* `%j` - JSON. Replaced with the string `'[Circular]'` if the argument
contains circular references.
* `%j` - JSON. Replaced with the string `'[Circular]'` if the argument contains circular references.
Copy link
Contributor

Choose a reason for hiding this comment

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

This line is over 80 characters now. Could you just remove the indentation from the original text?

@yorkie
Copy link
Contributor Author

yorkie commented Mar 8, 2015

Fixed @cjihrig Thank you

@brendanashworth
Copy link
Contributor

looks good to me

brendanashworth pushed a commit that referenced this pull request Mar 8, 2015
@brendanashworth
Copy link
Contributor

Thanks @yorkie, this has been merged in f8c893d.

Regarding the parser, the Makefile rule is here which seems to call this guy. Good luck 👍 if you want some more thoughts about it beforehand, you could open up an issue.

@rvagg rvagg mentioned this pull request Mar 8, 2015
@yorkie yorkie deleted the fix/doc-util branch March 9, 2015 03:22
@yorkie
Copy link
Contributor Author

yorkie commented Mar 9, 2015

Thanks for your link, @brendanashworth

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.

3 participants