AnswerDotAI / AnswerDotAI/nbdev

notebooks with auto in their name are skipped in doclinks

Offen
#1,430 0 Kommentare 2 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
bug
Vorherrschende Sprache
Jupyter Notebook
Sterne
5.3k
Forks
514
Ø Merge
2 T. 30 Min.
Gemergte PRs (30 T.)
8

Beschreibung

# Provide a minimally reproducible example

#1428 changed the following line

https://github.com/AnswerDotAI/nbdev/blob/8095d12c260dd7cc5d8c2ca34e89819c58fd679a/nbdev/doclinks.py#L74

to

https://github.com/AnswerDotAI/nbdev/blob/ea935f5cb6adf3f1206dc55f3b6256a7ec3e14a7/nbdev/doclinks.py#L80

which makes `nbdev_export` remove all the syms in `_modidx.py` for a notebook that has `auto` in its name, see for example the following PRs:

* https://github.com/Nixtla/mlforecast/pull/392/commits/4df35c74e86937fd9c2c5e973ed95ef894dfb001
* https://github.com/Nixtla/neuralforecast/pull/1085/commits/02db6808510d88913d2bd04abed8a3930766afa4

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne in nbdev/doclinks.py an der referenzierten Zeile und vergleiche die Änderungen aus #1428; reproduziere das Problem mit einem Notebook, dessen Name `auto` enthält, und führe `nbdev_export` aus. Erledigt ist es, wenn `_modidx.py` die Symbole dieses Notebooks beibehält, anstatt sie zu entfernen, wie in den verknüpften Commits von mlforecast und neuralforecast gezeigt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
jupyter-notebook, python
Bereich
documentation, tooling
Issue-Typ
Bug
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
48/100

Neue Issues direkt in Ihr Postfach

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