dotnet/msbuild

Document `RegisterTaskObject` ignoring `allowEarlyCollection`

Open

#10,425 opened on Jul 22, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C# (5,062 stars) (1,364 forks)batch import
Area: DocumentationArea: Enginehelp wantedtriaged

Description

https://github.com/dotnet/msbuild/blob/8b03742aafd18a26a5d03cd045e4d24963886503/src/Shared/RegisteredTaskObjectCacheBase.cs#L59-L64

Notice how allowEarlyCollection is ignored. It was dropped in some pre-GitHub release. We should document that.

Contributor guide

Tech stack
csharp
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
familiarity with C#understanding of MSBuild's task object caching
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue points to a specific file: src/Shared/RegisteredTaskObjectCacheBase.cs. The documentation should clarify that the allowEarlyCollection parameter is ignored. Check the code and possibly the method's XML documentation to confirm. No linked PRs or comments indicate blockers.
Document `RegisterTaskObject` ignoring `allowEarlyCollection` · dotnet/msbuild#10425 | Good First Issue