docs: improve code readability showing perf gains #45
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
docs/content/index.fsx
Outdated
Contributor
There was a problem hiding this comment.
Why is using the full namespace better?
Author
There was a problem hiding this comment.
Because one can distinguish in a quicker way that it's using the library in this block.
Author
There was a problem hiding this comment.
(i.e. had no idea about ParStream class until I saw the sources...)
Contributor
There was a problem hiding this comment.
I think it's better to do it by adding a comment
Author
|
I've now used type aliasing instead, should be clearer and not so repetitive. |
Two improvements here: 1. It's better to show the slowest first. 2. Rather use type aliasing instead of namespace opening (before, the connection between `open Nessos.Streams` and Stream|ParStream was not so clear). It took me a minute to wrap my head around this code, so I think with these 2 improvements, others will understand it a bit better the first time they read it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Two improvements here:
namespace explicitly.
It took me a minute to wrap my head around this code,
so I think with these 2 improvements, other will understand
it a bit better the first time they read it.