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

\0 in comment replaced with 0 in docs #8841

Closed
michaelkrukov opened this Issue Sep 2, 2018 · 1 comment

Comments

Projects
None yet
3 participants
@michaelkrukov
Copy link

michaelkrukov commented Sep 2, 2018

Description

Comments for readChar and peekChar are different from comments for them in source code. Difference is '\0' in source replaced by '0' in the documentation. It doesn't seems right. Correct me if i'm wrong.

Links

https://nim-lang.org/docs/streams.html#readChar
https://github.com/nim-lang/Nim/tree/master/lib/pure/streams.nim#L177

@Araq

This comment has been minimized.

Copy link
Member

Araq commented Sep 2, 2018

I think RST uses the backslash for escaping and so that should have been written \\0, but it's definitely something we need to look into.

komainu8 added a commit to komainu8/Nim that referenced this issue Sep 28, 2018

Fix nim-lang#8841
Modify comments for readChar and peekChar to the same as the comment for them in the source code.

@komainu8 komainu8 referenced this issue Sep 28, 2018

Merged

Fix #8841 #9101

@Araq Araq closed this in #9101 Oct 9, 2018

Araq added a commit that referenced this issue Oct 9, 2018

Fixes #8841 (#9101)
Modify comments for readChar and peekChar to the same as the comment for them in the source code.

krux02 added a commit to krux02/Nim that referenced this issue Oct 15, 2018

Fixes nim-lang#8841 (nim-lang#9101)
Modify comments for readChar and peekChar to the same as the comment for them in the source code.

narimiran added a commit to narimiran/Nim that referenced this issue Oct 31, 2018

Fixes nim-lang#8841 (nim-lang#9101)
Modify comments for readChar and peekChar to the same as the comment for them in the source code.

narimiran added a commit to narimiran/Nim that referenced this issue Nov 1, 2018

Fixes nim-lang#8841 (nim-lang#9101)
Modify comments for readChar and peekChar to the same as the comment for them in the source code.

narimiran added a commit that referenced this issue Nov 1, 2018

Fixes #8841 (#9101)
Modify comments for readChar and peekChar to the same as the comment for them in the source code.

narimiran added a commit that referenced this issue Nov 1, 2018

Fixes #8841 (#9101)
Modify comments for readChar and peekChar to the same as the comment for them in the source code.

(cherry picked from commit fe19670)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment