Uh oh!
There was an error while loading. Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Better break this to multiple lines. It'll make commenting easier.
This paragraph doesn't look like part of the document, but your comment for the document, @iq8al ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, those are my comments, which should be overwritten with the real text if we can come to a conclusion @yungyuc
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I prefer to put comments and discussions in github issue/PR tracker. In this way the document itself remains self-contained.
If we really want to put our comments into the document, we should explicitly mark it. Because I don't like this idea, I am not proposing a format. But I think such a format should include a clear todo mark (XXX, FIXME, etc.) and a the commenter's identity.
@iq8al could you go with either way (or another option you like) in your next update of this PR?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, the issue tracker is there to be used anyway, so comments will go there instead. Proposal to editing the document can go as PR then.