Skip to content

Conversation

@cbagpipe
Copy link
Contributor

Description

  • In NetworkStream constructor parameters descriptions was misplaced. Fixed it.

Motivation and Context

  • Avoid confusion.
  • It's my first PR. So I highly motivated to train on this little fixes how to do PR's right.

How Has This Been Tested?

  • Checked by eyes.

Screenshots

Types of changes

  • Documentation (changes or updates in the documentation, has no impact on code or features)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

~ fixed parameter description misplacement
@dnfadmin
Copy link

dnfadmin commented Dec 16, 2021

CLA assistant check
All CLA requirements met.

Copy link
Member

@networkfusion networkfusion left a comment

Choose a reason for hiding this comment

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

Looks good, but I would also recommend removing the excess namespace from the documentation as it (should) be obvious. But preferably make it a doc ref: https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/language-specification/documentation-comments)...

@cbagpipe
Copy link
Contributor Author

@networkfusion, thanks. I will in future PR's. Now I have not enough experience to somehow edit this PR... commit... or what should I actually do to follow your advice?

@networkfusion
Copy link
Member

networkfusion commented Dec 16, 2021

@networkfusion, thanks. I will in future PR's. Now I have not enough experience to somehow edit this PR... commit... or what should I actually do to follow your advice?

Just change and commit and push to your source (same) branch and this PR will update automagically....

~ plane text fqdn namespaces changed to crefs to improve readability
@cbagpipe
Copy link
Contributor Author

@networkfusion, done!

Copy link
Member

@josesimoes josesimoes left a comment

Choose a reason for hiding this comment

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

Thanks for fixing this. I just added a couple more fixes to it. 😉

@josesimoes josesimoes enabled auto-merge (squash) December 16, 2021 08:26
@josesimoes josesimoes merged commit 83ce593 into nanoframework:develop Dec 16, 2021
@nfbot
Copy link
Member

nfbot commented Dec 16, 2021

@cbagpipe thank you again for your contribution! 🙏😄

.NET nanoFramework it's all about community involvement and no contribution is too small.
We would like to invite you to join the project Contributors list.

Please edit it and add an entry with your GitHub user in the appropriate location (names sorted alphabetically):

  <tr>
    <td><img src="https://github.com/cbagpipe.png?size=50&" height="50" width="50" ></td>
    <td><a href="https://github.com/cbagpipe">Conroy Bagpipe</a></td>
  </tr>

(feel free to adjust your name, if it's not correct)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants