microsoft/cpprestsdk

Documentation Typo

Open

#189 建立於 2016年7月5日

在 GitHub 查看
 (6 留言) (0 反應) (0 負責人)C++ (7,596 star) (1,670 fork)batch import
help wanted

描述

http://microsoft.github.io/cpprestsdk/classpplx_1_1task.html

As listed it states:

pplx::task< _ReturnType > Class Template Reference

However, the < _ReturnType > is described as "_ResultType" as written in the description as follows:

The Parallel Patterns Library (PPL) task class. A task object represents work that can be executed asynchronously, and concurrently with other tasks and parallel work produced by parallel algorithms in the Concurrency Runtime. It produces a result of type _ResultType

Is this a typo?

貢獻者指南

技術棧
cpprest api
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
1
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
無
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
90
研究方向
The issue reports a typo in the documentation for the pplx::task class template. The page at http://microsoft.github.io/cpprestsdk/classpplx 1 1task.html uses ' ReturnType' in the title but ' ResultType' in the description. The fix involves locating the documentation source (likely a Doxygen comment in the C++ header file) and ensuring consistency. No linked PRs or assignees; the issue remains open and unaddressed.