GitHub docs updates #22
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I swear this better be the last time I do this. Also I deserve credit because I did this all from my phone.
fix site link too
fix links in readme (#23)
add discord invite link
edjubuh
approved these changes
Jun 25, 2017
There was a problem hiding this comment.
@HotelCalifornia feel free to squash commit this when all the changes are done
HotelCalifornia
pushed a commit
that referenced
this pull request
Jun 11, 2019
- Changed port number validation to return ENXIO when outside the domain of port numbers - Changed port validation to return ENODEV when the requested device doesn't match the actual device - Vision Sensor read/get functions consistently use EAGAIN when the libv5rts tells us it couldn't get data - Remove docstrings for EACCES since it is practically impossible to get that errno (we wait for mutex indefinitely) - vision_get_by_sig consistently sets errno to EDOM when unable to find objects that match (valid) arguments Right now, our returned errnos aren't that great. Close #117 - [X] When objects are in vision sensors FOV, but none are of a particular signature, signature ID is correct and EDOM is errno ```cpp errno = 0; // set to 0 to make sure errno is being set properly... normally wouldn't do this // errno was 33 b/c there were no objects to see of signature 1 pros::lcd::print(1, "%d (%d)", vision.get_by_sig(0, 1).signature, errno); errno = 0; // errno was 0 b/c it worked fine pros::lcd::print(2, "%d (%d)", vision.get_by_sig(0, 2).signature, errno); errno = 0; // errno was flickered between 0/33 b/c there were sometimes objects of 2 to see pros::lcd::print(3, "%d (%d)", vision.get_by_sig(2, 2).signature, errno); errno = 0; // errno was EINVAL (22) because 8 is an invalid signature id pros::lcd::print(4, "%d (%d)", vision.get_by_sig(8, 2).signature, errno); errno = 0; // errno was EADDRINUSE (112) b/c there was a radio plugged in pros::lcd::print(5, "%d (%d)", pros::c::vision_get_by_sig(21, 0, 1).signature, errno); errno = 0; // errno was ENXIO (6) b/c there's no smart port #22 pros::lcd::print(6, "%d (%d)", pros::c::vision_get_by_sig(22, 0, 1).signature, errno); // errno was ENODEV (19) b/c there's no motor plugged into 2 (or anything for that matter) errno = 0; pros::lcd::print(7, "%d (%d)", pros::c::motor_get_voltage(2), errno); ```
HotelCalifornia
pushed a commit
that referenced
this pull request
Jun 11, 2019
Summary - Changed port number validation to return ENXIO when outside the domain of port numbers - Changed port validation to return ENODEV when the requested device doesn't match the actual device - Vision Sensor read/get functions consistently use EAGAIN when the libv5rts tells us it couldn't get data - Remove docstrings for EACCES since it is practically impossible to get that errno (we wait for mutex indefinitely) - vision_get_by_sig consistently sets errno to EDOM when unable to find objects that match (valid) arguments Right now, our returned errnos aren't that great. Close #117 - [X] When objects are in vision sensors FOV, but none are of a particular signature, signature ID is correct and EDOM is errno ```cpp errno = 0; // set to 0 to make sure errno is being set properly... normally wouldn't do this // errno was 33 b/c there were no objects to see of signature 1 pros::lcd::print(1, "%d (%d)", vision.get_by_sig(0, 1).signature, errno); errno = 0; // errno was 0 b/c it worked fine pros::lcd::print(2, "%d (%d)", vision.get_by_sig(0, 2).signature, errno); errno = 0; // errno was flickered between 0/33 b/c there were sometimes objects of 2 to see pros::lcd::print(3, "%d (%d)", vision.get_by_sig(2, 2).signature, errno); errno = 0; // errno was EINVAL (22) because 8 is an invalid signature id pros::lcd::print(4, "%d (%d)", vision.get_by_sig(8, 2).signature, errno); errno = 0; // errno was EADDRINUSE (112) b/c there was a radio plugged in pros::lcd::print(5, "%d (%d)", pros::c::vision_get_by_sig(21, 0, 1).signature, errno); errno = 0; // errno was ENXIO (6) b/c there's no smart port #22 pros::lcd::print(6, "%d (%d)", pros::c::vision_get_by_sig(22, 0, 1).signature, errno); // errno was ENODEV (19) b/c there's no motor plugged into 2 (or anything for that matter) errno = 0; pros::lcd::print(7, "%d (%d)", pros::c::motor_get_voltage(2), errno); ```
HotelCalifornia
pushed a commit
that referenced
this pull request
Jun 12, 2019
Summary - Changed port number validation to return ENXIO when outside the domain of port numbers - Changed port validation to return ENODEV when the requested device doesn't match the actual device - Vision Sensor read/get functions consistently use EAGAIN when the libv5rts tells us it couldn't get data - Remove docstrings for EACCES since it is practically impossible to get that errno (we wait for mutex indefinitely) - vision_get_by_sig consistently sets errno to EDOM when unable to find objects that match (valid) arguments Right now, our returned errnos aren't that great. Close #117 - [X] When objects are in vision sensors FOV, but none are of a particular signature, signature ID is correct and EDOM is errno ```cpp errno = 0; // set to 0 to make sure errno is being set properly... normally wouldn't do this // errno was 33 b/c there were no objects to see of signature 1 pros::lcd::print(1, "%d (%d)", vision.get_by_sig(0, 1).signature, errno); errno = 0; // errno was 0 b/c it worked fine pros::lcd::print(2, "%d (%d)", vision.get_by_sig(0, 2).signature, errno); errno = 0; // errno was flickered between 0/33 b/c there were sometimes objects of 2 to see pros::lcd::print(3, "%d (%d)", vision.get_by_sig(2, 2).signature, errno); errno = 0; // errno was EINVAL (22) because 8 is an invalid signature id pros::lcd::print(4, "%d (%d)", vision.get_by_sig(8, 2).signature, errno); errno = 0; // errno was EADDRINUSE (112) b/c there was a radio plugged in pros::lcd::print(5, "%d (%d)", pros::c::vision_get_by_sig(21, 0, 1).signature, errno); errno = 0; // errno was ENXIO (6) b/c there's no smart port #22 pros::lcd::print(6, "%d (%d)", pros::c::vision_get_by_sig(22, 0, 1).signature, errno); // errno was ENODEV (19) b/c there's no motor plugged into 2 (or anything for that matter) errno = 0; pros::lcd::print(7, "%d (%d)", pros::c::motor_get_voltage(2), errno); ```
HotelCalifornia
pushed a commit
that referenced
this pull request
Jun 12, 2019
Summary - Changed port number validation to return ENXIO when outside the domain of port numbers - Changed port validation to return ENODEV when the requested device doesn't match the actual device - Vision Sensor read/get functions consistently use EAGAIN when the libv5rts tells us it couldn't get data - Remove docstrings for EACCES since it is practically impossible to get that errno (we wait for mutex indefinitely) - vision_get_by_sig consistently sets errno to EDOM when unable to find objects that match (valid) arguments Right now, our returned errnos aren't that great. Close #117 - [X] When objects are in vision sensors FOV, but none are of a particular signature, signature ID is correct and EDOM is errno ```cpp errno = 0; // set to 0 to make sure errno is being set properly... normally wouldn't do this // errno was 33 b/c there were no objects to see of signature 1 pros::lcd::print(1, "%d (%d)", vision.get_by_sig(0, 1).signature, errno); errno = 0; // errno was 0 b/c it worked fine pros::lcd::print(2, "%d (%d)", vision.get_by_sig(0, 2).signature, errno); errno = 0; // errno was flickered between 0/33 b/c there were sometimes objects of 2 to see pros::lcd::print(3, "%d (%d)", vision.get_by_sig(2, 2).signature, errno); errno = 0; // errno was EINVAL (22) because 8 is an invalid signature id pros::lcd::print(4, "%d (%d)", vision.get_by_sig(8, 2).signature, errno); errno = 0; // errno was EADDRINUSE (112) b/c there was a radio plugged in pros::lcd::print(5, "%d (%d)", pros::c::vision_get_by_sig(21, 0, 1).signature, errno); errno = 0; // errno was ENXIO (6) b/c there's no smart port #22 pros::lcd::print(6, "%d (%d)", pros::c::vision_get_by_sig(22, 0, 1).signature, errno); // errno was ENODEV (19) b/c there's no motor plugged into 2 (or anything for that matter) errno = 0; pros::lcd::print(7, "%d (%d)", pros::c::motor_get_voltage(2), errno); ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add information about our various repositories in the contribution guidelines.
These can be basically dropped in to the same file in our other repositories.
Seeking input on my examples of issues that should be opened in each repo, as I think they're a little lame.