JuliaDiff / JuliaDiff/ChainRulesCore.jl
Seperate internal API from Dev Tools in docs?
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 267
- Forks
- 66
- PR merge metrics
- No merged PRs in 30d
Description
I wonder if we should have two sections for what docs currently call internal.
One with things that people can use but mostly shouldn't outside of development (dev tools maybe?),
and one for things that are actually internal and not part of the public API.
We could even export things like clear_new_rule_hooks! and debug_mode from a ChainRulesCore.DevTools submodule? so you could using ChainRulesCore.DevTools to get them?
Probably beyond the scope of this PR.
I will open an issue to think about it
Originally posted by @oxinabox in https://github.com/_render_node/MDIzOlB1bGxSZXF1ZXN0UmV2aWV3VGhyZWFkMjk2NDE5Nzc1OnYy/pull_request_review_threads/discussion
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the documentation's current treatment of internal APIs, including clear_new_rule_hooks! and debug_mode. Decide how development-only tools should be separated from truly internal functionality and whether a ChainRulesCore.DevTools submodule belongs in the public API; done means the scope and documentation structure are agreed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100