Skip to content

Improve comments, enhance readability in FCFSScheduling.java #5500

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

Closed
wants to merge 4 commits into from

Conversation

Hardvan
Copy link
Contributor

@Hardvan Hardvan commented Oct 1, 2024

The comment improvements for the FCFSScheduling class provide clear and concise explanations of the non-preemptive First Come First Serve (FCFS) scheduling algorithm. The class-level documentation describes how processes are executed in the order they arrive, establishing a solid context for users. Each method is accompanied by detailed comments outlining its purpose, input parameters, and the steps taken, such as calculating waiting and turnaround times. Inline comments within the methods further clarify key operations and logic, enhancing code readability and maintainability while ensuring compliance with Java documentation standards.

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized it.
  • All filenames are in PascalCase.
  • All functions and variable names follow Java naming conventions.
  • All new algorithms have a URL in their comments that points to Wikipedia or other similar explanations.
  • All new code is formatted with clang-format -i --style=file path/to/your/file.java

@codecov-commenter
Copy link

codecov-commenter commented Oct 1, 2024

Codecov Report

Attention: Patch coverage is 83.33333% with 1 line in your changes missing coverage. Please review.

Project coverage is 52.29%. Comparing base (7f60d57) to head (a957878).

Files with missing lines Patch % Lines
...a/com/thealgorithms/scheduling/FCFSScheduling.java 83.33% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff            @@
##             master    #5500   +/-   ##
=========================================
  Coverage     52.28%   52.29%           
- Complexity     3256     3257    +1     
=========================================
  Files           525      525           
  Lines         15185    15185           
  Branches       2887     2887           
=========================================
+ Hits           7940     7941    +1     
  Misses         6920     6920           
+ Partials        325      324    -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Hardvan Hardvan marked this pull request as ready for review October 1, 2024 13:46
@siriak
Copy link
Member

siriak commented Oct 2, 2024

This is not needed, the comments just duplicate what's already written in code

@siriak siriak closed this Oct 2, 2024
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.

3 participants