Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
M
micropython
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
card10
micropython
Commits
7a4694fc
Commit
7a4694fc
authored
7 years ago
by
Damien George
Browse files
Options
Downloads
Patches
Plain Diff
docs/library/gc: Fix grammar and improve readability of gc.threshold().
parent
0a54b6dc
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/library/gc.rst
+15
-15
15 additions, 15 deletions
docs/library/gc.rst
with
15 additions
and
15 deletions
docs/library/gc.rst
+
15
−
15
View file @
7a4694fc
...
...
@@ -41,24 +41,24 @@ Functions
.. function:: threshold([amount])
Set or query additional GC allocation threshold. Normally,
GC is
triggered when new allocation cannot be satisfied, i.e. on
out of
memory (OOM) condition. If this function is called, in addition to
OOM,
GC
will be triggered each time after *amount*
of
bytes ha
s
been
allocated (in total, since the previous time such amount of bytes
ha
d
been allocated). *amount* is usually specified as less than the
full heap size, with the intention to trigger
GC
earlier than the
heap
will be
exhausted, and in the hope that early
GC
will prevent
excessive memory fragmentation. This is a heuristic measure, effect
of which will vary from
an
application to application, as well as
the optimal value of *amount* parameter.
Calling the function without argument will return current value of
the threshold.
V
alue of -1 means a disabled allocation threshold.
Set or query
the
additional GC allocation threshold. Normally,
a collection
is
triggered
only
when
a
new allocation cannot be satisfied, i.e. on
an
out-of-
memory (OOM) condition. If this function is called, in addition to
OOM,
a collection
will be triggered each time after *amount* bytes ha
ve
been
allocated (in total, since the previous time such
an
amount of bytes
ha
ve
been allocated). *amount* is usually specified as less than the
full heap size, with the intention to trigger
a collection
earlier than
when
the
heap
becomes
exhausted, and in the hope that
an
early
collection
will prevent
excessive memory fragmentation. This is a heuristic measure,
the
effect
of which will vary from application to application, as well as
the optimal value of
the
*amount* parameter.
Calling the function without argument will return
the
current value of
the threshold.
A v
alue of -1 means a disabled allocation threshold.
.. admonition:: Difference to CPython
:class: attention
This function is MicroPython extension. CPython has a similar
This function is
a
MicroPython extension. CPython has a similar
function - ``set_threshold()``, but due to different GC
implementations, its signature and semantics are different.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment