Fix ADR formatting, translate documentation, and enhance comments - #6
Merged
Conversation
…o root Six ADR files had a leading tab before the header block that made the disclaimer/table render as a code block under CommonMark. Also relocated adr-config.adrplus from docs/adr/ into the repo root (where the installed adrplus tool actually resolves it from) and filled in its previously empty template field with the real Context/Decision/Consequences skeleton.
…R TEST-PLAN.md api-documentation-guide.md was still heavily in Brazilian Portuguese; translated to en-US to match the rest of the docs tree. tests/TEST-PLAN.md was a pt-BR test rollout plan whose rollout is long finished; deleted (recoverable via history).
…nces
Swept // , /* */ and /// comments across src/ and tests/ (excluding license
headers and auto-generated files). Translated remaining Portuguese comments to
English, removed references to internal rollout plans/phases now long finished
("Fase 1/2", "Grupo N"), and dropped comments that only restated obvious code
instead of explaining a non-obvious why. No code logic changed.
Bitbucket.cs had a duplicated/merged license-header fragment on line 1. Style.cs's <remarks> sentence was cut off mid-clause; completed it to describe the implicit Color-to-Style conversion it was referring to.
Updated the project version in ConsolePlus.csproj from 1.0.0-Beta4 to 1.0.0-Beta5. No other changes were made.
Updated ConsolePlus.WriteLines(int) docs to clarify the 'steps' parameter as "Number of lines." Improved Style struct and Background property documentation with remarks on implicit Color conversion for quick foreground-only styles.
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
1 participant
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.
This pull request focuses on improving documentation clarity, consistency, and English localization for the ConsolePlus project. It updates the API documentation guide to English, clarifies code comments, and makes minor improvements to code and documentation for better usability and maintainability.
Documentation improvements:
docs/api-documentation-guide.md: Fully translated the API documentation guide from Portuguese to English, clarified instructions and best practices, and improved explanations for configuration, XML comments, troubleshooting, and version control. [1] [2] [3] [4]README.md: Added a NuGet badge showing the latest package version including pre-releases.docs/adr/adr-config.adrplus→adr-config.adrplus: Updated the ADR template for better context, decision, and consequences structure.docs/api/ConsolePlus.md: Fixed a typo in the parameter description forWriteLines.docs/api/Style.md: Improved remarks for style usage and clarified implicit conversion information. [1] [2]Code and comment refinements:
src/ConsoleAbstractions/AnsiColorBuilder.cs: Removed redundant comments and improved code clarity in the color system switch statement.src/ConsoleAbstractions/AnsiConsoleAdapter.cs: Cleaned up and clarified comments, improved English phrasing, and removed unnecessary or redundant remarks for better maintainability. [1] [2] [3] [4] [5]