doc-comment-updating-emilie #67

Merged
Hemmily merged 5 commits from doc-comment-updating-emilie into main 2026-03-18 19:55:44 +00:00
Owner
No description provided.
Closes #55
All checks were successful
/ build_and_test (push) Successful in 38s
/ Static Release Build (push) Has been skipped
8474c1315d
Remove NOTE and TODO comments from update_unchecked
All checks were successful
/ build_and_test (push) Successful in 39s
/ Static Release Build (push) Has been skipped
9383d7fcaa
Closes #57 as the NOTE was removed, but created #66 to track the problem
in the future.
Remove TODO and rewrite comments to not use "we"
All checks were successful
/ build_and_test (push) Successful in 38s
/ Static Release Build (push) Has been skipped
b7ecd8838b
Closes #50
Athamantis approved these changes 2026-03-18 19:47:05 +00:00
Dismissed
sebgab requested changes 2026-03-18 19:47:17 +00:00
Dismissed
sebgab left a comment
Owner

Couple minor things

Couple minor things
@ -1,4 +1,5 @@
#![allow(dead_code)]
//! This module handles what buttons are clicked in the elevator system
Owner

clicked -> pressed

Also consider changing to something along the lines of:
Monitors the elevator buttons and updates the state accordingly

clicked -> pressed Also consider changing to something along the lines of: Monitors the elevator buttons and updates the state accordingly
Author
Owner

I like this one more image

I like this one more ![image](/attachments/974e690c-6354-413a-b23e-389652de75c3)
268 KiB
Hemmily marked this conversation as resolved
@ -1,3 +1,5 @@
//! This module handles the elevator knowing what floor it is on and moving the elevator when it is safe to do so
Owner

This module handles the elevator knowing what floor it is on

Is this not the floor handler?

> This module handles the elevator knowing what floor it is on Is this not the floor handler?
Author
Owner

yeah it is more monitoring that it knows (through get_current_floor). Updated slightly to correspond

yeah it is more monitoring that it knows (through get_current_floor). Updated slightly to correspond
Hemmily marked this conversation as resolved
@ -1,11 +1,11 @@
//! This module handles obstructions and communicating if an elevator is obstructed to the elevator server
Owner

It does not handle obstructions, it monitors for obstructions and updates the state

It does not _handle_ obstructions, it monitors for obstructions and updates the state
Author
Owner

Very true, edited

Very true, edited
Hemmily marked this conversation as resolved
Merge branch 'main' into doc-comment-updating-emilie
All checks were successful
/ build_and_test (push) Successful in 38s
/ Static Release Build (push) Has been skipped
e989527bf8
Edited based on comments
All checks were successful
/ build_and_test (push) Successful in 38s
/ Static Release Build (push) Has been skipped
525c74f6d6
Athamantis approved these changes 2026-03-18 19:55:03 +00:00
sebgab approved these changes 2026-03-18 19:55:19 +00:00
Hemmily deleted branch doc-comment-updating-emilie 2026-03-18 19:55:45 +00:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
3 participants
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
TTK4145/elevator!67
No description provided.