Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/writing-plugins/generating-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,8 +219,9 @@ It emits a DO NOT EDIT header derived from the source file and plugin name:
# Generated by protoc-gen-hello v0.1.0 with parameter "".
```

It also emits `# ruff: noqa` to suppress linting on generated code, and
`# fmt: off` to prevent formatters from modifying it.
It also emits `# ruff: noqa` to suppress linting on generated code,
directives that stop pyright and ty from reporting its use of deprecated
symbols, and `# fmt: off` to prevent formatters from modifying it.
Use the `no_fmt_off` option (see [Options](./options.md#no_fmt_off)) to omit
`# fmt: off` if you want ruff to format the output.

Expand Down
6 changes: 6 additions & 0 deletions docs/writing-plugins/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,9 @@ src/gen/
# Generated by protoc-gen-hello v0.1.0 with parameter "".
# ruff: noqa: PGH004
# ruff: noqa
# pyright: reportDeprecated=false
# ty: ignore[unused-ignore-comment]
# ty: ignore[deprecated, unused-ignore-comment]
# fmt: off

from __future__ import annotations
Expand Down Expand Up @@ -151,6 +154,9 @@ For `user/v1/user.proto` this produces `src/gen/user/v1/user_rpc.py`:
# Generated by protoc-gen-rpc v0.1.0 with parameter "".
# ruff: noqa: PGH004
# ruff: noqa
# pyright: reportDeprecated=false
# ty: ignore[unused-ignore-comment]
# ty: ignore[deprecated, unused-ignore-comment]
# fmt: off

from __future__ import annotations
Expand Down
3 changes: 3 additions & 0 deletions examples/plugin/tests/gen/user/v1/user_pb.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions examples/plugin/tests/gen/user/v1/user_rpc.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions examples/protobuf/src/example/gen/example_pb.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion packages/bench/src/bench/gen/buffa/bench_messages_pb.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion packages/bench/src/bench/gen/buffa/benchmarks_pb.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion packages/bench/src/bench/gen/fleetbench/Message0_pb.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion packages/bench/src/bench/gen/fleetbench/Message10_pb.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion packages/bench/src/bench/gen/fleetbench/Message11_pb.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion packages/bench/src/bench/gen/fleetbench/Message12_pb.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion packages/bench/src/bench/gen/fleetbench/Message13_pb.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion packages/bench/src/bench/gen/fleetbench/Message14_pb.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion packages/bench/src/bench/gen/fleetbench/Message15_pb.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion packages/bench/src/bench/gen/fleetbench/Message16_pb.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion packages/bench/src/bench/gen/fleetbench/Message17_pb.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion packages/bench/src/bench/gen/fleetbench/Message18_pb.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion packages/bench/src/bench/gen/fleetbench/Message19_pb.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion packages/bench/src/bench/gen/fleetbench/Message1_pb.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion packages/bench/src/bench/gen/fleetbench/Message2_pb.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion packages/bench/src/bench/gen/fleetbench/Message3_pb.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion packages/bench/src/bench/gen/fleetbench/Message4_pb.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion packages/bench/src/bench/gen/fleetbench/Message5_pb.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion packages/bench/src/bench/gen/fleetbench/Message6_pb.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion packages/bench/src/bench/gen/fleetbench/Message7_pb.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion packages/bench/src/bench/gen/fleetbench/Message8_pb.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion packages/bench/src/bench/gen/fleetbench/Message9_pb.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion packages/bench/src/bench/gen/home/home_pb.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading