Skip to content

Restoring helpful code documentation and context#856

Open
AndreAugustoDev wants to merge 2 commits intobongodevs:mainfrom
AndreAugustoDev:dev
Open

Restoring helpful code documentation and context#856
AndreAugustoDev wants to merge 2 commits intobongodevs:mainfrom
AndreAugustoDev:dev

Conversation

@AndreAugustoDev
Copy link
Contributor

@AndreAugustoDev AndreAugustoDev commented Mar 3, 2026

Lavamusic Pull Request

Description

This PR restores essential JSDoc blocks, technical context, and utility functions that were removed in commit 3834fcd.
In my opinion, while the previous cleanup aimed to reduce noise, it removed documentation that is vital for the project's long-term maintainability.
This restoration should be analyzed with care to ensure we have the right balance of code clarity.

Type of Change

  • Bug fix
  • New feature
  • Performance improvement
  • Refactor
  • Cleanup
  • Documentation update

Changes Made

  • Restored Technical JSDoc: Re-added documentation for core structures like the Sharding Manager, i18n constraints, and the Lavamusic class to explain "why" certain logic exists.
  • Recovered Utility Functions: Restored the getCountryCode function in src/utils/CountryEmojiFlag.ts, which is necessary for the locale system.
  • Contextual Comments: Added back logic explanations in commands like Move, Lyrics, and Deploy to assist with future refactors and debugging.
  • Branding Preservation: Ensured that NO old licensing or author data was restored; all branding and dependency updates remain intact.

Checklist

  • Code compiles without warnings
  • Formatted with pnpm format
  • Added/updated documentation
  • No breaking changes (restoration of existing logic)

Thank you for contributing to Lavamusic!

Restores technical documentation, JSDocs, and core logic comments previously removed in 3834fcd. This ensures code maintainability while preserving the updated branding and dependency versions.
TypeScript 5.9 now includes `Intl.DurationFormat` type declarations natively
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