Version lock griffe to 0.39 and fix some doc errors #4835
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
jleibs
added
📖 documentation
jleibs
changed the title
teh-cmc
approved these changes
Jan 17, 2024
emilk
approved these changes
Jan 17, 2024
emilk
pushed a commit
that referenced
this pull request
Jan 17, 2024
### What PRs for our doc tests started failing spuriously as griffe 0.39 was rolled out to github runners. A non-expected spontaneous upgrade to griffe is bad in general, so I added it to the requirements-doc. However, the failure is actually a valid warning about a non-conformant docstring so I fixed the error and kept us on 0.39 since the validation it does is actually useful and would be more obvious if you were introducing a new docstring. ### Checklist * [x] I have read and agree to [Contributor Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and the [Code of Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md) * [x] I've included a screenshot or gif (if applicable) * [x] I have tested the web demo (if applicable): * Using newly built examples: [app.rerun.io](https://app.rerun.io/pr/4835/index.html) * Using examples from latest `main` build: [app.rerun.io](https://app.rerun.io/pr/4835/index.html?manifest_url=https://app.rerun.io/version/main/examples_manifest.json) * Using full set of examples from `nightly` build: [app.rerun.io](https://app.rerun.io/pr/4835/index.html?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json) * [x] The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG - [PR Build Summary](https://build.rerun.io/pr/4835) - [Docs preview](https://rerun.io/preview/5e5cf8def0e884dd743718ce76b01e8d16a489b2/docs) <!--DOCS-PREVIEW--> - [Examples preview](https://rerun.io/preview/5e5cf8def0e884dd743718ce76b01e8d16a489b2/examples) <!--EXAMPLES-PREVIEW--> - [Recent benchmark results](https://build.rerun.io/graphs/crates.html) - [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)
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.
What
PRs for our doc tests started failing spuriously as griffe 0.39 was rolled out to github runners. A non-expected spontaneous upgrade to griffe is bad in general, so I added it to the requirements-doc.
However, the failure is actually a valid warning about a non-conformant docstring so I fixed the error and kept us on 0.39 since the validation it does is actually useful and would be more obvious if you were introducing a new docstring.
Checklist
mainbuild: app.rerun.ionightlybuild: app.rerun.io