doc: add page for stubbed functions #1945
Merged
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
UncleGrumpy
reviewed
Oct 29, 2025
doc/src/stubbed-functions.md
Outdated
| Stubbed functions serve several purposes in AtomVM: | ||
|
|
||
| 1. **Compatibility**: Allow BEAM modules that use these functions to work anyway | ||
| 3. **Environment Differences**: Functions that make no sense in embedded contexts but are required |
Collaborator
There was a problem hiding this comment.
What happened to #2? For simplicity you can number all of these as “1.” and the correct numbers should be generated automatically when the markdown is parsed.
UncleGrumpy
reviewed
Oct 29, 2025
Collaborator
UncleGrumpy
left a comment
UncleGrumpy
left a comment
There was a problem hiding this comment.
Great idea! I have had several social media interactions lately where people were asking for more specific details about differences in AtomVM from BEAM, this should be quite helpful.
There is one small mistake in the numbering of the list of reasons why a stub might be used, but otherwise looks good.
Keep a list of stubbed functions, so we can keep track of functions that may always return the same value. Signed-off-by: Davide Bettio <[email protected]>
bettio
force-pushed
the
stubbed-functions-doc
branch
from
1c4ebf4 to
0e5c4b0
Compare
pguyot
approved these changes
Oct 29, 2025
UncleGrumpy
approved these changes
Oct 29, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Keep a list of stubbed functions, so we can keep track of functions that may always return the same value.
These changes are made under both the "Apache 2.0" and the "GNU Lesser General
Public License 2.1 or later" license terms (dual license).
SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later