Doc comments point at internal BundleHandle members; OkfToolMode miscounts write tools; acme-retail-agent filters tools by hand

Open Beginner friendly
#259 0 comments 0 reactions 0 assignees View on GitHub

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

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

documentation

Area

Doc comments and a sample.

Problems

  • src/OKF4net/Providers/BundleRefreshPolicy.cs (lines 7, 23, 36) and src/OKF4net.Agents/OkfBundleTools.cs:260 point <see cref> at BundleHandle.Refresh / BundleHandle.Current, which are internal since #152; the public API is RefreshAsync / GetCurrentAsync.
  • src/OKF4net.Agents/OkfToolMode.cs: the summary says "three write-capable tools"; WriteToolNames has four (okf_verify included).
  • samples/acme-retail-agent/src/AcmeRetailAgent/Program.cs filters GetTools() against WriteToolNames by hand instead of calling GetTools(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

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from jchable/okf4net

All issues in jchable/okf4net

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.