Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bug] Remove Unused Commented Code to Improve Readability #295

Open
1 task done
Silvia-Wachira opened this issue Oct 15, 2024 · 2 comments · May be fixed by #305
Open
1 task done

[Bug] Remove Unused Commented Code to Improve Readability #295

Silvia-Wachira opened this issue Oct 15, 2024 · 2 comments · May be fixed by #305
Labels
💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟩 priority: low Low priority and doesn't need to be rushed 🧹 status: ticket work required Needs more details before it can be worked on

Comments

@Silvia-Wachira
Copy link

Silvia-Wachira commented Oct 15, 2024

Description

The current 404.html code for the CC Search Portal contains commented-out sections. Keeping unused code can make the file cluttered.This can make it harder for future developers to read and maintain it.The best practice would be to remove unnecessary code to improve its clarity and maintainability.

Reproduction

  1. Navigate towards the 404.html page in the src folder
  2. Locate the commented code

Expectation

Removing unused commented code will lead to a cleaner codebase and this will improve maintainability and reduce confusion for future contributors.

Screenshot

404html1
404html2

Environment

  • Device: (eg. iPhone Xs; laptop)
  • OS: (eg. iOS 13.5; Fedora 32)
  • Browser: (eg. Safari; Firefox)
  • Version: (eg. 13; 73)
  • Other info: (eg. display resolution, ease-of-access settings)

Additional context

If the commented code is intended for use in the future then it can be documented more clearly .

Resolution

  • I would be interested in resolving this bug.
@Silvia-Wachira Silvia-Wachira added 💻 aspect: code Concerns the software code in the repository 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work 🛠 goal: fix Bug fix 🟧 priority: high Stalls work on the project or its dependents labels Oct 15, 2024
@possumbilities
Copy link
Contributor

@Silvia-Wachira Can you please:

  • provide textual examples of these areas, listing them out if possible
  • verify this is not commenting inherited from Vocabulary (particularly in the header/footer).

@possumbilities possumbilities added 🧹 status: ticket work required Needs more details before it can be worked on 🟩 priority: low Low priority and doesn't need to be rushed and removed 🟧 priority: high Stalls work on the project or its dependents 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Oct 15, 2024
@Silvia-Wachira
Copy link
Author

@possumbilities As far as I'm concerned, It is not inheriting from vocabulary. Do correct me if I'm wrong

@Macomi27 Macomi27 linked a pull request Oct 20, 2024 that will close this issue
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟩 priority: low Low priority and doesn't need to be rushed 🧹 status: ticket work required Needs more details before it can be worked on
Projects
Status: Backlog
Development

Successfully merging a pull request may close this issue.

2 participants