h2oai/wave

Add @app to the Page Guide

Open

#581 创建于 2021年2月19日

在 GitHub 查看
 (3 评论) (0 反应) (0 负责人)Python (3,677 star) (279 fork)batch import
docsgood first issue

描述

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
~

贡献者指南

技术栈
python
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
PythonWave framework basics
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85
研究方向
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.