h2oai/wave

Add @app to the Page Guide

Open

#581 geöffnet am 19. Feb. 2021

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (3.677 Stars) (279 Forks)batch import
docsgood first issue

Beschreibung

Is your feature request related to a problem? Please describe

The @app('/') feature is explained in the API section of the docs (https://wave.h2o.ai/docs/api/server#app), but is only really find-able if someone is looking for it. When users are on the Pages section of the Guide (https://wave.h2o.ai/docs/pages/) it might be nice for them to explicitly learn about @app() as this is a shortcut for sending apps to a specific page.

Describe the solution you'd like

Add a brief sentence and code snippet to the Pages Guide: https://wave.h2o.ai/docs/pages/

Right after the code for To reference the current page in a Wave app, use q.page.. Here is a first-pass suggestion

image

To reference a specific page in a Wave app, use the `@app(/foo)` decorator

~
@app('/foo')
async def serve(q: Q):
    page = q.page
~

Contributor Guide

Tech Stack
python
Domain
documentation
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
PythonWave framework basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85
Research-Richtung
Edit the Pages guide at https://wave.h2o.ai/docs/pages/ to add a sentence and code snippet about the @app() decorator after the existing code for referencing the current page. Follow the suggestion in the issue description, which includes a code snippet using @app('/foo'). Ensure the addition is consistent with the existing documentation style.