fix(cli): correct and complete the generate command help#18
Open
Reefact wants to merge 1 commit into
Open
Conversation
The --format help listed only "json or markdown (alias: md)", omitting the built-in html format (declared in RendererCatalog.BuiltInFactories). The --layout help called it a "Markdown layout", but single/split apply to the html format too (only json is single-only). - --format: mention html alongside json and markdown. - --layout: describe it as a document layout and state which formats support it, instead of tying it to Markdown. - Mirror the same wording in the CliConfiguration doc comments. - Add the missing description on the `renderer add <PATH>` argument so it appears in --help. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016y9NbS218s4nPXEUBvnf6W
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Contexte
Bug B4 — Aide du CLI incomplète/incorrecte. Deux descriptions d'aide de la commande
generateétaient fausses, et un audit du reste de l'aide CLI a révélé deux points de cohérence associés.Le bug
--formathtmlest un format intégré (RendererCatalog.BuiltInFactories→HtmlErrorDocumentationRenderer.Format => "html") mais était absent de l'aide.--layoutsingle/splits'appliquent aussi au format html (sonSupportedLayouts=[Single, Split]). Seul json est limité àsingle. Le libellé « Markdown » était trompeur.Changements
GenerateSettings.cs--format→ « Output format: json, markdown (alias: md) or html. »--layout→ « Document layout: single or split. Applies to the markdown and html formats (json is single only). »CliConfiguration.cs— mêmes formulations dans les commentaires XML (mirroir des valeurs par défaut) alignées :htmlajouté au format, layout décrit comme document layout.RendererAddCommand.cs— l'argumentrenderer add <PATH>n'avait aucune[Description], donc l'aide de la sous-commande n'expliquait pas le<PATH>. Description ajoutée (avec leusing System.ComponentModel;requis).Vérification
Aucun SDK .NET n'est disponible dans l'environnement d'exécution, donc la compilation n'a pas pu être exercée. Les modifications se limitent à des chaînes
[Description]/commentaires XML et à l'ajout d'unusingd'un namespace standard — faible risque.🤖 Generated with Claude Code
Generated by Claude Code