Skip to content

Comments

feat: updated documentation#29

Merged
Zubs merged 1 commit intomasterfrom
documentation-updates
Oct 19, 2025
Merged

feat: updated documentation#29
Zubs merged 1 commit intomasterfrom
documentation-updates

Conversation

@Zubs
Copy link
Owner

@Zubs Zubs commented Oct 19, 2025

This pull request updates documentation for the toroman library, focusing on expanding feature descriptions, improving method documentation, and clarifying contribution guidelines. The most important changes include adding new features to the README, rewriting method documentation with better type annotations and error handling, and updating the contributing guide to reference the correct project and platform.

README enhancements:

  • Expanded the feature list in README.md to include multiplication, division, max/min, random generation, and table generation for Roman numerals.
  • Rewrote method documentation in README.md with TypeScript-style signatures, improved descriptions, explicit error handling, and updated examples for all core methods (toRoman, fromRoman, isRoman, sum, diff, multiply, divide, max, min, random, table, range). [1] [2] [3] [4] [5] [6]

Contribution guide improvements:

  • Updated templates/contributing.md to reference toroman instead of Transcriptase, and replaced all instances of "Github" with "GitHub" for consistency. [1] [2]
  • Improved bug reporting instructions by providing a direct link to open new issues and clarifying the use of GitHub issues for bug tracking.
  • Updated style guide instructions to use npm run format instead of npm run lint for code style unification.

@Zubs Zubs merged commit 84c7dfb into master Oct 19, 2025
3 checks passed
@Zubs Zubs deleted the documentation-updates branch October 19, 2025 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant