[PR #5451] [CLOSED] docs: improve code comments and remove TODO items #5215

Closed
opened 2026-03-17 02:40:56 +03:00 by kerem · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/hoppscotch/hoppscotch/pull/5451
Author: @shaiksajidhussain
Created: 10/5/2025
Status: Closed

Base: mainHead: docs/improve-code-comments


📝 Commits (1)

  • b32d7df docs: improve code comments and remove TODO items

📊 Changes

3 files changed (+5 additions, -5 deletions)

View changed files

📝 packages/hoppscotch-common/src/components/smart/ChangeLanguage.vue (+1 -2)
📝 packages/hoppscotch-common/src/helpers/editor/extensions/HoppPredefinedVariables.ts (+3 -2)
📝 packages/hoppscotch-data/src/predefinedVariables.ts (+1 -1)

📄 Description

  • Replace vague TODO comment in ChangeLanguage component with clear description
  • Remove unnecessary TODO in changeLocale function (already implemented)
  • Improve comment in HoppPredefinedVariables.ts explaining alternative implementation
  • Update comment in predefinedVariables.ts for better extensibility documentation

Improves code maintainability and developer experience

Closes #

What's changed

Notes to reviewers


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/hoppscotch/hoppscotch/pull/5451 **Author:** [@shaiksajidhussain](https://github.com/shaiksajidhussain) **Created:** 10/5/2025 **Status:** ❌ Closed **Base:** `main` ← **Head:** `docs/improve-code-comments` --- ### 📝 Commits (1) - [`b32d7df`](https://github.com/hoppscotch/hoppscotch/commit/b32d7dfecb180fecf44bb2233f865e7d693c2c76) docs: improve code comments and remove TODO items ### 📊 Changes **3 files changed** (+5 additions, -5 deletions) <details> <summary>View changed files</summary> 📝 `packages/hoppscotch-common/src/components/smart/ChangeLanguage.vue` (+1 -2) 📝 `packages/hoppscotch-common/src/helpers/editor/extensions/HoppPredefinedVariables.ts` (+3 -2) 📝 `packages/hoppscotch-data/src/predefinedVariables.ts` (+1 -1) </details> ### 📄 Description - Replace vague TODO comment in ChangeLanguage component with clear description - Remove unnecessary TODO in changeLocale function (already implemented) - Improve comment in HoppPredefinedVariables.ts explaining alternative implementation - Update comment in predefinedVariables.ts for better extensibility documentation Improves code maintainability and developer experience <!-- Thanks for creating this pull request 🤗 Please make sure that the pull request is limited to one type (docs, feature, etc.) and keep it as small as possible. You can open multiple prs instead of opening a huge one. --> <!-- If this pull request closes an issue, please mention the issue number below --> Closes # <!-- Issue # here --> <!-- Add an introduction into what this PR tries to solve in a couple of sentences --> ### What's changed <!-- Describe point by point the different things you have changed in this PR --> <!-- You can also choose to add a list of changes and if they have been completed or not by using the markdown to-do list syntax - [ ] Not Completed - [x] Completed --> ### Notes to reviewers <!-- Any information you feel the reviewer should know about when reviewing your PR --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
kerem 2026-03-17 02:40:56 +03:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/hoppscotch#5215
No description provided.