Remove uses of doc(hidden) to create private APIs

Offen
#1,564 4 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
42/100
Issue-Typ
Refactoring
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
rust
Bereich
backend-api-design, documentation

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache
Rust
Sterne
4.3k
Forks
391
Keine gemergten PRs in 30 T.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus rust-ndarray/ndarray

Alle Issues in rust-ndarray/ndarray

Ähnliche Issues

Weitere Issues zu Rust

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.