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

Multithreading Interface Documentation #90

Merged
merged 16 commits into from
Aug 18, 2023
Merged

Conversation

ClayJay3
Copy link
Collaborator

@ClayJay3 ClayJay3 commented Aug 15, 2023

Threading Docs

Added a detailed guide on how developers should use the AutonomyThread interface. It goes over how to actually inherit the class and implement the pure virtual functions, as well as some basics on how resources should be handled with mutexes, locks, and atomics.

README is in the src/threads folder.

A thorough readthrough from a few different people would be nice to catch any errors/inaccuracies or make any suggestions about the formatting.

@ClayJay3 ClayJay3 added documentation Issues related to improving, updating, or creating documentation for the project. 1-Star Indicates a very easy task or challenge, suitable for beginners with minimal effort required. labels Aug 15, 2023
@ClayJay3 ClayJay3 added this to the URC 2024 - Sprint 0 milestone Aug 15, 2023
@ClayJay3 ClayJay3 requested a review from Byrdman32 August 15, 2023 17:28
@ClayJay3 ClayJay3 self-assigned this Aug 15, 2023
@ClayJay3 ClayJay3 linked an issue Aug 15, 2023 that may be closed by this pull request
@Byrdman32 Byrdman32 requested a review from jessedeuel August 15, 2023 17:32
@Byrdman32
Copy link
Member

Added Jesse as a reviewer since the Drone Autonomy Code will be based off of Autonomy_Software - Sprint 0

@Byrdman32
Copy link
Member

Also, make sure to merge development now that the #89 has been merged.

@ClayJay3 ClayJay3 requested a review from Byrdman32 August 15, 2023 19:26
Copy link
Member

@Byrdman32 Byrdman32 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved

@Byrdman32 Byrdman32 removed the request for review from UhOhDonovan August 17, 2023 01:15
@Byrdman32
Copy link
Member

@ClayJay3 Donovan says that it looks good and approves the PR.

@Byrdman32 Byrdman32 removed the request for review from jessedeuel August 17, 2023 02:54
@Byrdman32
Copy link
Member

@ClayJay3 Jesse says that it looks good and approves the PR.

@ClayJay3
Copy link
Collaborator Author

Why don't they just approve it?

@jessedeuel
Copy link

I don't have the correct permissions. Eli is gonna fix it tomorrow.

@Byrdman32
Copy link
Member

Byrdman32 commented Aug 17, 2023

Because GitHub is being stupid and wasn't letting Jesse approve it. And Donovan didn't have access to his computer when he reviewed it and asked me to mark it for him.

Copy link
Member

@wiidler wiidler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks awesome, sorry for the delay in getting a review in

@ClayJay3 ClayJay3 merged commit 7a2ba3b into development Aug 18, 2023
@ClayJay3 ClayJay3 deleted the topic/threading-docs branch August 18, 2023 00:34
MRDT-Software pushed a commit that referenced this pull request May 14, 2024
Multithreading Interface Documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1-Star Indicates a very easy task or challenge, suitable for beginners with minimal effort required. documentation Issues related to improving, updating, or creating documentation for the project.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Multithreading interface documentation
4 participants