Remove uses of doc(hidden) to create private APIs

Open
#1,564 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
42/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Stale
Tech stack
rust
Domain
backend-api-design, documentation

Research direction

Search the Rust crate for #[doc(hidden)] uses, then read src/lib.rs around line 65 to understand the documentation exception. Review which instances should no longer be publicly visible, remove the referenced documentation line once those changes are complete, and verify the crate documentation reflects the new visibility.

Written by the indexing model from the issue text.

Description

docs tracking-issue

The library liberally uses #[doc(hidden)] to "hide" APIs that it wants to be internal. This poses a slight challenge to maintenance, since changing those is technically a public breaking change. Although this may be necessary or desired in some cases, I believe that most instance should be altered to no longer be publicly visible.

Once finished, remove this line from the crate documentation.

Dominant language
Rust
Stars
4.3k
Forks
391
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rust-ndarray/ndarray

All issues in rust-ndarray/ndarray

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.