吐槽一下你们的文档

新手专区
标签: #<Tag:0x00007f4ce1ff8dd8>

(189) #1

帮助文档表面分了数据、模块和文档三个部分,但是不方便搜索,比如我想搜索context这个函数怎么使用?要3个都ctrl+f一遍,不如直接搞一个直接搜索帮助中心所有内容的引擎,还方便很多;事实上,目前我就算把context搜索了一遍,还是一知半解,‘用户自定义数据,在回调函数中要用到的变量,需要从这里传入,并通过 context.options 使用’???——你们这个options跟其他平台是有明显区别的,其他的平台一般就是用context各种持仓细节查询,或者变成全局变量使用;在这里,我真没搞懂context.options到底干嘛?

此外,文档中,每个都有个‘使用示例’,本来以为可以看看表达的格式例子,结果转向社区搜索引擎??大多数“使用示例”根本就没有。

API文档对你们平台实在太重要了,文档如果做得好,省去大量的咨询重复回答工作,用户开发效率也高很多。


(189) #2

context.options我看实例已经明白这个是从读取上一个模块传入的数据,但不是从帮助中心学来的,另外options单词完全看不出它的本意;另外像
context.perf_tracker.position_tracker之类让人晕菜啊


(iQuant) #3

您好,感谢您的反馈,您的建议我们已全部记录下来,文档板块我们一直有在优化,我们也会根据您提到的这些内容进行针对性优化,您在使用过程中有任何意见建议可以随时向我们反馈哈。


(华尔街的猫) #4


这类接口是不推荐使用的,可能以前的某些样例策略里有,后面都逐步改回来了。

文档我们会持续优化,感谢反馈。