dotnet / dotnet/dotnet-api-docs
Return value from PeriodicTimer.WaitForNextTickAsync is not properly documented
- Lingua principale
- C#
- Stelle
- 949
- Fork
- 1.7k
- Merge medio
- 2g 19h
- PR unite (30g)
- 52
Descrizione
### Type of issue
Missing information
### Description
`PeriodicTimer.WaitForNextTickAsync` returns `ValueTask`
The documentation for the return describes the `ValueTask` bit of this, but not the meaning of the `bool` contents.
The documentation should cover _both_ the circumstances of the task complation _and_ the value of the result. Currently it only does the former.
### Page URL
https://learn.microsoft.com/en-us/dotnet/api/system.threading.periodictimer.waitfornexttickasync?view=net-10.0
### Content source URL
https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Threading/PeriodicTimer.xml
### Document Version Independent Id
0ef31de4-0c6b-4ae5-b172-c2e89beee4cc
### Platform Id
cdfefd6d-f8e5-d855-490d-211d69650a39
### Article author
@dotnet-bot
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Apri xml/System.Threading/PeriodicTimer.xml e individua la voce WaitForNextTickAsync. Leggi la documentazione attuale del valore restituito e confrontala con la descrizione dell'issue. Il lavoro è completato quando la documentazione spiega sia quando viene completata la ValueTask, sia cosa significa il valore bool restituito.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- csharp
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 1/5
- Tempo stimato
- Meno di un'ora
- Stato di attività
- Ferma
- Chiarezza
- Specificata chiaramente
- Idoneità per principianti
- 55/100