Skip to content

docs: document a critical bscan limitation#460

Merged
frb121 merged 1 commit intomasterfrom
dev/fbergkemper/master/s2791
Mar 26, 2020
Merged

docs: document a critical bscan limitation#460
frb121 merged 1 commit intomasterfrom
dev/fbergkemper/master/s2791

Conversation

@frb121
Copy link
Contributor

@frb121 frb121 commented Mar 25, 2020

This is just a draft which needs to be discussed.

@frb121 frb121 requested a review from arogge March 25, 2020 17:55
@frb121 frb121 force-pushed the dev/fbergkemper/master/s2791 branch from 0e22fe3 to e5ab069 Compare March 25, 2020 18:02
Copy link
Member

@arogge arogge left a comment

Choose a reason for hiding this comment

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

This is great documentation that explains the limitation in detail. I really appreciate it!

I personally like to structure ReST with one sentence per line. This helps to get reasonable diffs that show changes in content and not in the plain-text formatting. It also helps the writer to detect overly long sentences, which may lead to shorter sentences and simpler language. However, as always YMMV.

@frb121
Copy link
Contributor Author

frb121 commented Mar 26, 2020

Any more comments? If not, I'm going to rebase the draft and open the actual PR.

@frb121 frb121 force-pushed the dev/fbergkemper/master/s2791 branch from eb8bc59 to b1b8de1 Compare March 26, 2020 09:08
@frb121 frb121 marked this pull request as ready for review March 26, 2020 09:08
Copy link
Contributor

@franku franku left a comment

Choose a reason for hiding this comment

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

Some minor suggestions on a PM

@frb121 frb121 force-pushed the dev/fbergkemper/master/s2791 branch from b1b8de1 to c763065 Compare March 26, 2020 09:41
@frb121 frb121 force-pushed the dev/fbergkemper/master/s2791 branch from c763065 to 6b0e848 Compare March 26, 2020 09:44
@frb121 frb121 merged commit 9aef75f into master Mar 26, 2020
@frb121 frb121 deleted the dev/fbergkemper/master/s2791 branch March 26, 2020 09:45
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