Skip to content

docs: update API examples with new handle parameter#607

Merged
viferga merged 2 commits intometacall:developfrom
ridmii:fix/update-from-single-file-docs
Dec 26, 2025
Merged

docs: update API examples with new handle parameter#607
viferga merged 2 commits intometacall:developfrom
ridmii:fix/update-from-single-file-docs

Conversation

@ridmii
Copy link
Copy Markdown
Contributor

@ridmii ridmii commented Dec 21, 2025

Updated documentation examples for:
-from_single_file
-from_file
-from_memory

Added None as handle parameter to match new API signature.

Description

Please include a summary of the change and which issue is fixed. List any dependencies that are required for this change.

Fixes #(issue_no)

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Documentation update

Checklist:

  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have added tests/screenshots (if any) that prove my fix is effective or that my feature works.
  • I have tested the tests implicated (if any) by my own code and they pass (make test or ctest -VV -R <test-name>).
  • If my change is significant or breaking, I have passed all tests with ./docker-compose.sh test &> output and attached the output.
  • I have tested my code with OPTION_BUILD_ADDRESS_SANITIZER or ./docker-compose.sh test-address-sanitizer &> output and OPTION_TEST_MEMORYCHECK.
  • I have tested my code with OPTION_BUILD_THREAD_SANITIZER or ./docker-compose.sh test-thread-sanitizer &> output.
  • I have tested with Helgrind in case my code works with threading.
  • I have run make clang-format in order to format my code and my code follows the style guidelines.

If you are unclear about any of the above checks, have a look at our documentation here.

Updated documentation examples for:
-from_single_file
-from_file
-from_memory

Added None as handle parameter to match new API signature.
@ridmii
Copy link
Copy Markdown
Contributor Author

ridmii commented Dec 21, 2025

@viferga

Found Pre-existing CI Build/Path Issue

Following up on the CI failures, I investigated further and found that the missing derpyramda.js module is part of the source code:
It is defined as a Node.js project in source/scripts/node/derpyramda/.

The test source/ports/py_port/test/test_simple.py (line ~63) tries to import from it.
The MODULE_NOT_FOUND error indicates this module is not being built or deployed correctly to the test environment in CI.

Conclusion Reinforced: My documentation-only PR does not affect the CMake build system or the deployment path of the derpyramda test module. The CI failures for both the Node.js module resolution and the Python segmentation fault are pre-existing infrastructure or flaky test issues.

@viferga
Copy link
Copy Markdown
Member

viferga commented Dec 26, 2025

: My documentation-only PR does not affect the CMake build system or the deployment path of the derpyramda test module. The CI failures for both the Node.js module resolut

Don't worry that is because those CIs are work in progress. Your PR is fine, I am merging it.

@viferga viferga merged commit 1c29797 into metacall:develop Dec 26, 2025
39 of 55 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants