一个好示例最重要的特点

文档里的示例代码，最重要的是【0】。

开始练习 →

⚠️ 示例最容易过时在哪

示例代码最容易失效的原因是【0】。

开始练习 →

示例该放在哪儿

让示例最不容易过时的做法是【0】。

开始练习 →

两个示例，哪个跑不通

模块对外只提供 add、sub、div、mod、sqrt 五个函数。文档里有两个示例。运行下面这段程序： def bad_examples(examples, api): return [e for e, f in examples

开始练习 →

找出跑不通的示例

补全 bad_examples(examples, api)：每项是 (示例代码, 用到的函数名)，返回用了 API 里没有的函数的那些示例。 输出跑不通的示例有几个。

开始练习 →

算出示例的可用率

输出两样：能跑通的示例数 / 可用率百分比。

开始练习 →

把示例改对

把用了 average 的那个示例改成用 API 里真实存在的函数，输出改之前和改之后跑不通的示例数。

开始练习 →

⚠️ 三项检查一起报

把三项一起查，输出四样：缺的小节数 / 没说明的函数数 / 跑不通的示例数 / 合计。

开始练习 →

验证文档最可靠的办法

要确认 README 真的能用，最可靠的是【0】。

开始练习 →

⚠️ 谁最适合验证一份 README

验证 README 好不好用，最合适的人是【0】。

开始练习 →