chore: add disclaimer and fix grammar #24
Closed
Conversation
This file contains hidden or 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
zabackary
commented
Feb 22, 2025
| vexide's goal regarding hardware is to support as many devices as possible with as much functionality as possible while providing consistent and reliable interfaces for programmers. For example, vexide provides support for many rarely-used legacy sensors and the [V5 Electromagnet](https://docs.rs/vexide-devices/latest/vexide_devices/smart/electromagnet/struct.Electromagnet.html), despite it being illegal in competition use. | ||
|
|
||
| We also aim to be as consistently well-documented as possible. Our [API reference](https://docs.rs/vexide) contains detailed descriptions and examples of every type, function, and constant you can use. In some cases, vexide's documentation can be more detailed than official documentation. Information has been collected from multiple sources, including the [BLRS Wiki](https://wiki.purduesigbots.com/), first-party testing, and fragmented sources such as comments made on [VEXforum](https://www.vexforum.com/). | ||
| We also aim to be as consistently well-documented as possible. Our [API reference](https://docs.rs/vexide) contains detailed descriptions and examples of every type, function, and constant you can use. In some cases, vexide's documentation can be more detailed than official documentation. Information has been collected from multiple sources, including the [BLRS Wiki](https://wiki.purduesigbots.com/), first-party testing, and fragmented sources such as comments made on [VEXforum](https://www.vexforum.com/). |
There was a problem hiding this comment.
Did I remove a newline or something?
|
Closing, since |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Unless
stdsupport arrives, one can't use every crate on crates.io. Also, there was a bit of weird wording in one part.