microsoft/cpprestsdk

Documentation Typo

Open

#189 opened on Jul 5, 2016

View on GitHub
 (6 comments) (0 reactions) (0 assignees)C++ (7,596 stars) (1,670 forks)batch import
help wanted

Description

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?

Contributor guide

Tech stack
cpprest api
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
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.