TimeSpanConverter example is misleading, seems to suggest conversion from Ticks in string format, which is not correct
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 88/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- csharp
- Domain
- documentation
Research direction
Start with xml/System.ComponentModel.TimeSpanConverter.xml and compare the TimeSpanConverter example with the linked API page. Correct the misleading statement about ticks and the shown string conversion, then verify the updated wording across the affected documentation versions.
Written by the indexing model from the issue text.
Description
Type of issue
Other (describe below)
Description
Example states
Both variables are represented in Ticks format
before converting from "5000000" to a timespan. This seems to read that the conversion will parse from the tick value of a timespan back into a TimeSpan. This is not true, TypeDescriptor.GetConverter(ts).ConvertFrom(myTSStr) treats the string format as days resulting in "5000000.00:00:00", and throwing an overflow exception if you try and do it with ticks for any timespan more than about 1 second because of what that results in in terms of ticks.
This is wrong across multiple versions of the documentation.
Page URL
https://learn.microsoft.com/en-us/dotnet/api/system.componentmodel.timespanconverter?view=net-10.0
Content source URL
Document Version Independent Id
79d7390a-d984-7fc7-aa5e-baeba420fb84
Platform Id
04e77bb7-dad8-79b0-d531-8c44a26d9c5f
Article author
@dotnet-bot
- Dominant language
- C#
- Stars
- 954
- Forks
- 1.7k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 61
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from dotnet/dotnet-api-docs
-
area-System.Net.Http untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
dotnet/dotnet-api-docs#13153 · 1 comment ·
Maintainers usually reply within 1 day
-
dotnet-target-version untriaged
Difficulty 1/5 Under an hour Newbie friendliness 90/100
dotnet/dotnet-api-docs#13129 ·
Maintainers usually reply within 1 day
-
dotnet-target-version untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
dotnet/dotnet-api-docs#13128 ·
Maintainers usually reply within 1 day
-
Typo: 'ifs' instead of 'its' in `System.Array.IndexOf(Array, Object, Int32, Int32)` function descriptionPossibly taken @gewarren claimed this 7 days ago. Openuntriaged
Difficulty 1/5 Under an hour Newbie friendliness 95/100
dotnet/dotnet-api-docs#13122 · 1 assignee ·
Maintainers usually reply within 1 day
-
area-System.Threading untriaged
Difficulty 1/5 Under an hour Newbie friendliness 90/100
dotnet/dotnet-api-docs#13091 ·
Maintainers usually reply within 1 day
All issues in dotnet/dotnet-api-docs
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
stryker-mutator/stryker-net#3892 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
MobiFlight/MobiFlight-Connector#3419 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Kryptos-FR/MarkView.Avalonia#105 ·
Maintainers usually reply within 1 day
-
[辞書]Open提案 辞書
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
microsoft/fluentui-blazor#5410 ·
Maintainers usually reply within 1 day