Docs: cleanup leftovers in functions.rst #1972
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
https://doc.atomvm.org/main/apidocs/libatomvm/functions.html has these leftover functions: eg say `context_unlink` etc: ``` Warning doxygenfunction: Cannot find function “context_unlink” in doxygen xml output for project “libatomvm” from directory: /__w/AtomVM/AtomVM/build/doc/xml/ ``` AI created this script for cleanup: https://gist.github.com/petermm/b8623716adf74f07ed00b2725cb8a415 But human verified. Signed-off-by: Peter M <petermm@gmail.com>
UncleGrumpy
suggested changes
Nov 11, 2025
Collaborator
There was a problem hiding this comment.
Thanks for catching this! We must have renamed these and never changed the function names for the docs. The updated functions are all context_* replacing the globalcontext_ names. All of these functions have doxygen documentation that should be included in the published C API docs.
bettio
approved these changes
Nov 12, 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.
https://doc.atomvm.org/main/apidocs/libatomvm/functions.html has these leftover functions: eg search for
doxygenfunction:AI created this script for cleanup: https://gist.github.com/petermm/b8623716adf74f07ed00b2725cb8a415
But human verified.
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