Doc comments point at internal BundleHandle members; OkfToolMode miscounts write tools; acme-retail-agent filters tools by hand
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 85/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- csharp
- Domain
- developer-experience, documentation
Research direction
Read the listed XML documentation comments in BundleRefreshPolicy.cs, OkfBundleTools.cs, and OkfToolMode.cs, then inspect Program.cs in the acme-retail-agent sample. Update the cref targets and write-tool count, and replace the hand-built filter with the GetTools(OkfToolMode.ReadOnly) call. Done when the sample still runs and the documentation matches the public API and tool count.
Written by the indexing model from the issue text.
Description
Area
Doc comments and a sample.
Problems
src/OKF4net/Providers/BundleRefreshPolicy.cs(lines 7, 23, 36) andsrc/OKF4net.Agents/OkfBundleTools.cs:260point<see cref>atBundleHandle.Refresh/BundleHandle.Current, which are internal since #152; the public API isRefreshAsync/GetCurrentAsync.src/OKF4net.Agents/OkfToolMode.cs: the summary says "three write-capable tools";WriteToolNameshas four (okf_verifyincluded).samples/acme-retail-agent/src/AcmeRetailAgent/Program.csfiltersGetTools()againstWriteToolNamesby hand instead of callingGetTools(OkfToolMode.ReadOnly).
Acceptance
Docs point at public members and state the right count; the sample uses the idiomatic call and still runs.
- Dominant language
- C#
- Stars
- 4
- Forks
- 1
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 32
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 jchable/okf4net
-
.NET bug
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
test
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
documentation good first issue
Difficulty 1/5 1-3 hours Newbie friendliness 90/100
Maintainers usually reply within 1 day
-
documentation good first issue
Difficulty 1/5 Under an hour Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
documentation good first issue
Difficulty 1/5 Under an hour Newbie friendliness 90/100
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
area/backend type/bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
umbraco/Umbraco-CMS#24668 · 1 comment ·
Maintainers usually reply within 1 day
-
Pri3
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
MicrosoftDocs/windows-dev-docs#6205 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
area-ai untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
dotnet/extensions#7956 ·
Maintainers usually reply within 1 day