chore(api): lint API doc example protocol files#18142
Merged
Conversation
SyntaxColoring
approved these changes
Apr 23, 2025
Contributor
SyntaxColoring
left a comment
SyntaxColoring
left a comment
There was a problem hiding this comment.
Love it, thank you!
FYI you can usually prefix a variable with _, like _trash_bin, to indicate to tools that it's deliberately unused.
Contributor
Author
|
Interesting! I don't think we'd necessarily advise protocol authors to do that. A little too 🐍 |
ddcc4
pushed a commit
that referenced
this pull request
May 16, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified
ddcc4
pushed a commit
that referenced
this pull request
May 16, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified
ddcc4
pushed a commit
that referenced
this pull request
May 16, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified
ddcc4
pushed a commit
that referenced
this pull request
May 16, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified
ddcc4
pushed a commit
that referenced
this pull request
May 16, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified
ddcc4
pushed a commit
that referenced
this pull request
May 16, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified
ddcc4
pushed a commit
that referenced
this pull request
May 17, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified
ddcc4
pushed a commit
that referenced
this pull request
May 17, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified
ddcc4
pushed a commit
that referenced
this pull request
May 17, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified
ddcc4
pushed a commit
that referenced
this pull request
May 17, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified (cherry picked from commit 8e72a89)
ddcc4
pushed a commit
that referenced
this pull request
May 17, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified (cherry picked from commit 8e72a89)
ddcc4
pushed a commit
that referenced
this pull request
May 17, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified (cherry picked from commit 8e72a89)
ddcc4
pushed a commit
that referenced
this pull request
May 17, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified (cherry picked from commit 8e72a89)
ddcc4
pushed a commit
that referenced
this pull request
May 17, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified (cherry picked from commit 8e72a89)
ddcc4
pushed a commit
that referenced
this pull request
May 17, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified (cherry picked from commit 8e72a89)
ddcc4
pushed a commit
that referenced
this pull request
May 19, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified (cherry picked from commit 8e72a89)
ddcc4
pushed a commit
that referenced
this pull request
May 19, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified (cherry picked from commit 8e72a89)
ddcc4
pushed a commit
that referenced
this pull request
May 19, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified (cherry picked from commit 8e72a89)
ddcc4
pushed a commit
that referenced
this pull request
May 20, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified (cherry picked from commit 8e72a89)
ddcc4
pushed a commit
that referenced
this pull request
May 20, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified (cherry picked from commit 8e72a89)
ddcc4
pushed a commit
that referenced
this pull request
May 22, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified (cherry picked from commit 8e72a89)
ddcc4
pushed a commit
that referenced
this pull request
May 23, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified (cherry picked from commit 8e72a89)
ddcc4
pushed a commit
that referenced
this pull request
May 24, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified (cherry picked from commit 8e72a89)
ddcc4
pushed a commit
that referenced
this pull request
May 24, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified (cherry picked from commit 8e72a89)
ddcc4
pushed a commit
that referenced
this pull request
May 29, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified (cherry picked from commit 8e72a89)
ddcc4
pushed a commit
that referenced
this pull request
May 29, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified (cherry picked from commit 8e72a89)
ddcc4
pushed a commit
that referenced
this pull request
May 29, 2025
# Overview Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137. ## Test Plan and Hands on Testing 1. Add `docs/v2/example_protocols` to the `black` command `make -C api lint` and `make -C api format`. Was going to add it to `flake` as well, but these files deliberately violate some `flake` rules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis. 2. Everything should fail because I formatted these files with tabs like a heathen. 3. Run `format` and hopefully everything works. ## Changelog - [x] Update Makefile - [x] Update Python protocols to pass new lint ## Review requests Cool cool? ## Risk assessment v low, shouldn't introduce any CI failures unless the example protocols are modified (cherry picked from commit 8e72a89)
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.
Overview
Lint the Python protocol files distributed as part of the v2 API docs. Addresses RTC-137.
Test Plan and Hands on Testing
docs/v2/example_protocolsto theblackcommandmake -C api lintandmake -C api format. Was going to add it toflakeas well, but these files deliberately violate someflakerules, like never explicitly referring back to the trash bin but definitely requiring one to pass analysis.formatand hopefully everything works.Changelog
Review requests
Cool cool?
Risk assessment
v low, shouldn't introduce any CI failures unless the example protocols are modified