Skip to content

Docs: Update doctest info, enhance stdlib script #58503

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 23, 2025

Conversation

Keno
Copy link
Member

@Keno Keno commented May 23, 2025

  • Revise doc/README.md to mention JULIA_EXECUTABLE usage with doctests, adding a warning regarding built-in stdlibs
  • Enhance contrib/print_sorted_stdlibs.jl script to add --only-sysimg option to accurately list standard libraries built into the system image.

These modifications aim to provide clearer documentation and more effective tooling for contributors and AI agents wanting to run the doctests without building julia from scratch.

- Revise `doc/README.md` warning for `JULIA_EXECUTABLE` usage
  with doctests, updating to current GFM admonition syntax
  for improved clarity.
- Enhance `contrib/print_sorted_stdlibs.jl` script:
    - Add `--only-sysimg` option to accurately list standard
      libraries built into the system image.
    - Refine internal logic for sysimage-based filtering and
      ensure original comment state is preserved.

These modifications aim to provide clearer documentation and more
effective tooling for you and AI agents managing Julia doctest
environments and standard library configurations.
@Keno Keno merged commit 2bd37fb into master May 23, 2025
7 checks passed
@Keno Keno deleted the doc-script-final-corrections branch May 23, 2025 04:54
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.

1 participant