[Docs] Added useStaticBuffers function description #5820
Merged
Conversation
This file contains 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
pedrominatel
added
the
Type: Documentation
pedrominatel
changed the title
SuGlider
approved these changes
Nov 1, 2021
docs/source/api/wifi.rst
Outdated
| The use of dynamic allocation is recommended to save memory and reduce resources usage. However, the dynamic performs slightly slower than the static allocation. | ||
| Use static allocation if you want to have more performance and if your application is multi-tasking. | ||
|
|
||
| By default, the memory allocation will be set to *dynamic* if this function is not being used. |
There was a problem hiding this comment.
What about highlighting this default setting with bold or box format?
There was a problem hiding this comment.
I will probably put into bold the whole sentence but this is better than nothing :) other looks good to me!
VojtechBartoska
approved these changes
Nov 2, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Added
useStaticBuffersfunction description on the documentation.Impact
None.