AnswerDotAI / AnswerDotAI/nbdev

nbdev1 migration scripts and documentation needs to be improved

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

Beschreibung

I am doing a migration from nbdev1 to nbdev2 for my project, following https://nbdev.fast.ai/migrating.html document, and I have encountered the following problems.

- The nbdev_migrate script has some problems where the page description (which in nbdev1 was done as a quote just below h1 header) spanned more than one line; only the first line was copied.
- The nbdev_migrate script automatically converts directives, but it does not convert the old `notebook2script` calls
- In _"Update directive names"_ there is no need to do the convert directives, as it is handled by nbdev_migrate script
- With the exception of `git add $LIBNAME/_modidx.py` the migration documentation does not say anything about adding (or not) those newly downloaded files to the repository with `git add` - should it be done (and why), should it not be done (and why)?
- Instruction on how to update GitHub Pages settings is done **3** times.
- I think instead of using perl one can simply use sed in those examples (though I am not exactly sure which is easier for an ordinary user)

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit migrating.html und dem nbdev_migrate-Skript und prüfe die aufgeführten Migrationsschritte, die Behandlung von Direktiven, mehrzeilige Seitenbeschreibungen und alte notebook2script-Aufrufe. Überprüfe die Hinweise zu git add, den GitHub Pages-Einstellungen und perl im Vergleich zu sed. Als erledigt gilt die Aufgabe, wenn das Skript und die Migrationsdokumentation jeden gemeldeten Fall konsistent und ohne doppelte Anweisungen abdecken.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
jupyter-notebook, python
Bereich
documentation, tooling
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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