microsoft/cpprestsdk

Documentation Typo

Open

#189 geöffnet am 5. Juli 2016

Auf GitHub ansehen
 (6 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (7.596 Stars) (1.670 Forks)batch import
help wanted

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90
Research-Richtung
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.