Modify optimizer tutorial section of readme #252
+10
−4
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
In this section, the `Values` class was introduced and used for the first time without a proper explanation. I thought this might be confusing to new users and so have made these changes. Also, provided a bit more forwarning on how exactly we'll optimize the values, fixed a typo, and generally tried to improve the readability.
bradley-solliday-skydio
requested review from
aaron-skydio,
ryan-skydio and
hayk-skydio
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.
In this section, the
Valuesclass was introduced and used for the first time without a proper explanation. I thought this might be confusing to new users and so have made these changes.Also, provided a bit more forwarning on how exactly we'll optimize the values, fixed a typo, and generally tried to improve the readability.