docs(controller): examples use controller class #1221

dead-horse · 2017-07-21T08:31:56Z

Checklist

npm test passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

Description of change

mention-bot · 2017-07-21T08:31:59Z

@dead-horse, thanks for your PR! By analyzing the history of the files in this pull request, we identified @huacnlee, @cuyl and @lslxdx to be potential reviewers.

fengmk2 · 2017-07-21T09:08:53Z

docs/source/en/basics/controller.md

@@ -111,29 +111,29 @@ module.exports = app => {
 };
 ```

-### Methods in Controller
+### Methods in Controller (not recommend, only for compatbility)

 Every Controller is a generation function, whose first argument is the instance of the request [Context](./extend.md#context) through which we can access many attributes and methods, encapsulated by the framework, of current request conveniently.


should change this line too first argument

fengmk2 · 2017-07-21T09:09:27Z

docs/source/en/basics/controller.md

@@ -198,13 +198,13 @@ It can be seen from the above HTTP request examples that there are many places c
 Usually the Query String, string following `?` in the URL, is used to send parameters by request of GET type. For example, `category=egg&language=node` in `GET /posts?category=egg&language=node` is parameter that user sends. We can acquire this parsed parameter body through `context.query`:

 ```js
-exports.listPosts = function* (ctx) {
-  const query = ctx.query;
+* listPosts() {


写完整的 class

fengmk2 · 2017-07-21T09:10:08Z

docs/source/en/basics/controller.md

-exports.listPosts = function* (ctx) {
-  console.log(ctx.queries);
+* listPosts() {
+  console.log(this.ctx.queries);


如果是 class 就将 class 写完整

这样写阅读者会疑惑的

fengmk2 · 2017-07-21T09:12:08Z

docs/source/zh-cn/basics/controller.md

@@ -123,29 +123,29 @@ module.exports = app => {
 };
 ```

-### Controller 方法
+### Controller 方法（不推荐使用，只是为了兼容）

 每一个 Controller 都是一个 generator function，它的第一个参数是请求的上下文 [Context](./extend.md#context) 对象的实例，通过它我们可以拿到框架封装好的各种便捷属性和方法。


这里也要改描述

codecov · 2017-07-21T09:34:51Z

Codecov Report

Merging #1221 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1221   +/-   ##
=======================================
  Coverage   99.71%   99.71%           
=======================================
  Files          29       29           
  Lines         705      705           
=======================================
  Hits          703      703           
  Misses          2        2

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2b78b4c...b269b4b. Read the comment docs.

dead-horse · 2017-07-21T09:34:58Z

修改了

atian25 · 2017-07-24T01:54:58Z

docs/source/en/basics/controller.md

-        throw err;
+const Controller = require('egg').Controller;
+
+module.exports = class UploaderController extends Controller {


应该用 app.Controller 这种方式吧？我们不是不推荐 require('egg').Controller 么?

为什么不推荐？

我觉得这样比写一个 function return 要好

cc @popomore @fengmk2

只是内部看到这个有点奇怪，可能需要替换成内部框架的名字，这个另外想办法把，可以在内部文档构建的时候统一做替换，将 require('egg') 给替换掉

文档问题可以解决

dead-horse · 2017-07-25T03:12:09Z

这个还有什么问题？

docs(controller): examples use controller class

a1df61d

dead-horse added the type: document label Jul 21, 2017

dead-horse requested review from fengmk2 and popomore July 21, 2017 08:31

fengmk2 reviewed Jul 21, 2017

View reviewed changes

dead-horse added 2 commits July 21, 2017 17:29

f

e42aed7

f

689d8cd

atian25 requested changes Jul 24, 2017

View reviewed changes

f

b269b4b

atian25 approved these changes Jul 25, 2017

View reviewed changes

fengmk2 approved these changes Jul 25, 2017

View reviewed changes

fengmk2 merged commit c3c9fce into master Jul 25, 2017

fengmk2 deleted the docs-controller-refactor branch July 25, 2017 03:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(controller): examples use controller class #1221

docs(controller): examples use controller class #1221

dead-horse commented Jul 21, 2017

mention-bot commented Jul 21, 2017

fengmk2 Jul 21, 2017

fengmk2 Jul 21, 2017

fengmk2 Jul 21, 2017

fengmk2 Jul 21, 2017

fengmk2 Jul 21, 2017

codecov bot commented Jul 21, 2017 •

edited

Loading

dead-horse commented Jul 21, 2017

atian25 Jul 24, 2017

dead-horse Jul 24, 2017

dead-horse Jul 24, 2017

atian25 Jul 24, 2017

dead-horse Jul 24, 2017

fengmk2 Jul 25, 2017

dead-horse commented Jul 25, 2017

docs(controller): examples use controller class #1221

docs(controller): examples use controller class #1221

Conversation

dead-horse commented Jul 21, 2017

Checklist

Affected core subsystem(s)

Description of change

mention-bot commented Jul 21, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Jul 21, 2017 • edited Loading

Codecov Report

dead-horse commented Jul 21, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dead-horse commented Jul 25, 2017

codecov bot commented Jul 21, 2017 •

edited

Loading