microsoft/cpprestsdk

Documentation Typo

Open

#189 ouverte le 5 juil. 2016

Voir sur GitHub
 (6 commentaires) (0 réactions) (0 assignés)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?

Guide contributeur

Stack technique
cpprest api
Domaine
documentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
under 1 hour
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90
Direction de recherche
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.