ulab: move documentation to the right location #5028
Merged
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
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.
Update ulab to 3.3.1. This brings in some bugfixes and most importantly moves all the documentation items (as far as I could tell) to the right places.
Originally I thought this was going to be complicated due to the need to rename
ulab.ndarraytoulab.numpy.ndarraywith changes to both repos in parallel, but ultimately I found a way to do it compatibly, with a second step in ulab to remove an alias of thendarraytype that can be done after this merge—but nobody spends time with their CI in the red.This ends up being complicated, because of the way that ulab and circuitpython are interdependent -- to moveulab.ndarraytoulab.numpy.ndarrayin the documentation requires a tandem change in both projects, or there are build errors. This is one of the reasons that ulab's PR v923z/micropython-ulab#423 encountered build errors.I believe that if this PR comes up green, and the ulab branch in adafruit/ulab-circuitpython comes up green, that it should be safe to merge the doc changes to ulab, release it, then swiftly follow by merging this PR updated with the released ulab.In the meantime GitHub actions will be showing some red, we just have to understand why and be OK with it.@v923z
Closes #5033