Skip to content
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

Improve documentation on ScanAsync #238

Merged
merged 1 commit into from
Nov 15, 2022

Conversation

josesimoes
Copy link
Member

@josesimoes josesimoes commented Nov 15, 2022

Description

  • Add exceptions to the method.
  • Fix typos and add cross references.

Motivation and Context

How Has This Been Tested?

Screenshots

Types of changes

  • Improvement (non-breaking change that improves a feature, code or algorithm)
  • Bug fix (non-breaking change which fixes an issue with code or algorithm)
  • New feature (non-breaking change which adds functionality to code)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Config and build (change in the configuration and build system, has no impact on code or features)
  • Dependencies (update dependencies and changes associated, has no impact on code or features)
  • Unit Tests (add new Unit Test(s) or improved existing one(s), has no impact on code or features)
  • Documentation (changes or updates in the documentation, has no impact on code or features)

Checklist:

  • My code follows the code style of this project (only if there are changes in source code).
  • My changes require an update to the documentation (there are changes that require the docs website to be updated).
  • I have updated the documentation accordingly (the changes require an update on the docs in this repo).
  • I have read the CONTRIBUTING document.
  • I have tested everything locally and all new and existing tests passed (only if there are changes in source code).
  • I have added new tests to cover my changes.

josesimoes added a commit to nanoframework/Samples that referenced this pull request Nov 15, 2022
- Add sleep before 1st scan operation to allow time for initial connection.
- Improve comments.
- Following nanoframework/System.Device.Wifi#238.
@josesimoes josesimoes merged commit ce16ea4 into nanoframework:main Nov 15, 2022
@josesimoes josesimoes deleted the improve-doc-ScanAsync branch November 15, 2022 15:43
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.

2 participants