h2oai/wave

Add @app to the Page Guide

Open

Aperta il 19 feb 2021

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)Python (3677 star) (279 fork)batch import
docsgood first issue

Descrizione

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
~

Guida contributor

Tech stack
python
Dominio
documentation
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
under 1 hour
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
PythonWave framework basics
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85
Direzione di ricerca
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.