docs: Document Dagger.set_distributed_package! #602
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
I've added documentation for the `Dagger.set_distributed_package!` function. This includes: - A new section in the API documentation (`docs/src/api-dagger/functions.md`) detailing the function's signature, purpose, and the requirement to restart Julia after use. - A new "Quickstart: Package Management" section in the main index file (`docs/src/index.md`) providing a brief overview, a usage example, and a link to the detailed API docs. I've built the documentation locally to ensure correctness.
I've updated the header in `docs/src/index.md` from "Quickstart: Package Management" to "Quickstart: Distributed Package Selection" as you requested. This change clarifies the purpose of the section discussing `Dagger.set_distributed_package!`. I've rebuilt the documentation locally to ensure correctness.
I've updated the header in `docs/src/api-dagger/functions.md` from "Package Management Functions" to "Distributed Package Selection Functions" as you requested. This change aligns the terminology with the update made previously to `docs/src/index.md`. I've also rebuilt the documentation locally to ensure everything is correct.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
From jules.google.com:
I've added documentation for the
Dagger.set_distributed_package!function.This includes:
docs/src/api-dagger/functions.md) detailing the function's signature, purpose, and the requirement to restart Julia after use.docs/src/index.md) providing a brief overview, a usage example, and a link to the detailed API docs.I've built the documentation locally to ensure correctness.