CollectionBuilderAttribute.MethodName remarks contradict CollectionBuilderAttribute(Type, String) Constructor remarks
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 85/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- csharp
- Domain
- documentation
Research direction
Open xml/System.Runtime.CompilerServices/CollectionBuilderAttribute.xml and compare the MethodName property remarks with the CollectionBuilderAttribute(Type, String) constructor remarks. Update the contradictory documentation so it accurately reflects the currently supported pattern, then verify the generated MethodName API page shows consistent wording.
Written by the indexing model from the issue text.
Description
Type of issue
Other (describe below)
Description
The constructor remarks say the following:
methodName must refer to a static method that accepts a single parameter of type ReadOnlySpan<T> and returns an instance of the collection being built containing a copy of the data from that span.
The MethodName property remarks state:
This should match the metadata name of the target method. For example, this might be ".ctor" if targeting the type's constructor.
A constructor isn't a static method and can't return an instance of the collection. The constructor documentation says other patterns might be supported in the future, but currently using CollectionBuilderAttribute to specify creating it using the constructor isn't supported.
Page URL
Content source URL
Document Version Independent Id
368975ed-1538-7808-0601-bff5a85acefd
Platform Id
3bded7f0-22bf-9686-fc8b-1d65a64ef493
Article author
@dotnet-bot
- Dominant language
- C#
- Stars
- 950
- Forks
- 1.7k
- Avg merge
- 3d 5h
- Merged PRs (30d)
- 38
Contributor 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
-
untriaged
Difficulty 1/5 Under an hour Newbie friendliness 88/100
dotnet/dotnet-api-docs#13039 · 1 comment ·
-
DisplayAttribute string properties: Remarks incorrectly state the property performs resource lookup Openarea-System.ComponentModel.DataAnnotations untriaged
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
dotnet/dotnet-api-docs#13023 · 1 comment ·
-
area-System.Net.Sockets untriaged
Difficulty 1/5 Under an hour Newbie friendliness 88/100
dotnet/dotnet-api-docs#13022 · 1 comment ·
-
area-System.Runtime untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
dotnet/dotnet-api-docs#13015 · 1 comment ·
-
area-System.Runtime.InteropServices untriaged
Difficulty 1/5 Under an hour Newbie friendliness 84/100
dotnet/dotnet-api-docs#12959 ·
All issues in dotnet/dotnet-api-docs
Similar issues
-
type/automation type/tech-debt
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
t/bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
ci-failure-cause test-failure
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
area:auth FE mvp P3
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
klasolsson81/jobbliggaren#1788 ·