BundleConceptWriter returns agent-facing prose to library callers instead of a typed result

Open
#262 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
csharp
Domain
api

Research direction

Start with the public API for BundleConceptWriter in src/OKF4net and inspect WriteConceptAsync and its sibling methods, then read related issue #211 for context on error text. Decide the typed result shape and update the breaking API documentation and CHANGELOG; done means callers can distinguish outcomes and access result details without parsing prose.

Written by the indexing model from the issue text.

Description

.NET enhancement

Area

src/OKF4net — BundleConceptWriter public API.

Question

WriteConceptAsync (and siblings) return agent-facing prose to library callers: "Written tables/orders (new, 524 bytes). Remember to run okf_regenerate_indexes.", and expected failures as strings starting with Error: …. A library caller has to parse text to know whether the write happened. The tool wording belongs in OkfBundleTools; the core could return a typed result (outcome, key, version, bytes, refusal reason).

Breaking API change — design and CHANGELOG needed. Related: #211 (path-free I/O error texts in the same strings).

Found while writing the #174 tutorials.

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.