Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add NOLINT block to lint.py #7720

Merged
merged 4 commits into from
Oct 15, 2024
Merged

Add NOLINT block to lint.py #7720

merged 4 commits into from
Oct 15, 2024

Conversation

abey79
Copy link
Member

@abey79 abey79 commented Oct 14, 2024

What

Add NOLINT_START/NOLINT_END markers to lint.py, to exclude entire blocks. Useful eg. for documentation, where output of commands is shown verbatim.

TODO:

  • support NOLINT, etc. for markdown docs too

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested the web demo (if applicable):
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG
  • If applicable, add a new check to the release checklist!
  • If have noted any breaking changes to the log API in CHANGELOG.md and the migration guide

To run all checks from main, comment on the PR with @rerun-bot full-check.

Base automatically changed from antoine/rename-filter-is-not-null to main October 14, 2024 17:25
@abey79 abey79 force-pushed the antoine/nolint-blocks branch from a8e7c63 to 085c1d8 Compare October 14, 2024 17:27
@abey79 abey79 added 🧑‍💻 dev experience developer experience (excluding CI) and removed do-not-merge Do not merge this PR labels Oct 14, 2024
Copy link
Member

@emilk emilk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, but would be nice with a small test too

scripts/lint.py Outdated Show resolved Hide resolved
@Wumpf Wumpf self-assigned this Oct 15, 2024
@Wumpf
Copy link
Member

Wumpf commented Oct 15, 2024

looked a bit into adding tests for this, but it's a bit too much hassle right now since we don't have tests yet for lint_file (and I don't have time to sink into this right now)

@Wumpf Wumpf merged commit 57b15b0 into main Oct 15, 2024
34 checks passed
@Wumpf Wumpf deleted the antoine/nolint-blocks branch October 15, 2024 13:46
Wumpf added a commit that referenced this pull request Oct 15, 2024
### What

This PR introduces a How-to guid for the dataframe API which includes:

- a reference-style coverage of all dataframe api features
- recipes to ingest data in a pyarrow table, pandas df, polars df, or
duckdb relation

Needs this to pass CI:
- #7720 

### 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 examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/7727?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/7727?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
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!
* [x] If have noted any breaking changes to the log API in
`CHANGELOG.md` and the migration guide

- [PR Build Summary](https://build.rerun.io/pr/7727)
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)

To run all checks from `main`, comment on the PR with `@rerun-bot
full-check`.

---------

Co-authored-by: Andreas Reich <[email protected]>
Wumpf added a commit that referenced this pull request Oct 16, 2024
### What

WIP getting started guide. A skeleton with some working code for now.
Very much in need of feedback.

may need this to pass CI:
- #7720

### 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 examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/7643?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/7643?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
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!
* [x] If have noted any breaking changes to the log API in
`CHANGELOG.md` and the migration guide

- [PR Build Summary](https://build.rerun.io/pr/7643)
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)

To run all checks from `main`, comment on the PR with `@rerun-bot
full-check`.

---------

Co-authored-by: gavrelina <[email protected]>
Co-authored-by: Zeljko Mihaljcic <[email protected]>
Co-authored-by: Andreas Reich <[email protected]>
@emilk emilk added exclude from changelog PRs with this won't show up in CHANGELOG.md include in changelog and removed include in changelog exclude from changelog PRs with this won't show up in CHANGELOG.md labels Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants