Skip to content

Commit d585680

Browse files
author
Steve Ayers
committed
Rename Constraint to Rule
1 parent 12fa3e5 commit d585680

File tree

6 files changed

+183
-195
lines changed

6 files changed

+183
-195
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![PyPI version](https://badge.fury.io/py/protovalidate.svg)](https://badge.fury.io/py/protovalidate)
66

77
`protovalidate-python` is the Python implementation of [`protovalidate`](https://github.com/bufbuild/protovalidate),
8-
designed to validate Protobuf messages at runtime based on user-defined validation constraints. Powered by Google's
8+
designed to validate Protobuf messages at runtime based on user-defined validation rules. Powered by Google's
99
Common Expression Language ([CEL](https://github.com/google/cel-spec)), it provides a flexible and efficient foundation
1010
for defining and evaluating custom validation rules. The primary goal of `protovalidate` is to help developers ensure
1111
data consistency and integrity across the network without requiring generated code.
@@ -15,7 +15,7 @@ data consistency and integrity across the network without requiring generated co
1515
Head over to the core [`protovalidate`](https://github.com/bufbuild/protovalidate/) repository for:
1616

1717
- [The API definition](https://github.com/bufbuild/protovalidate/tree/main/proto/protovalidate/buf/validate/validate.proto):
18-
used to describe validation constraints
18+
used to describe validation rules.
1919
- [Documentation](https://github.com/bufbuild/protovalidate/tree/main/docs): how to apply `protovalidate` effectively
2020
- [Migration tooling](https://github.com/bufbuild/protovalidate/tree/main/docs/migrate.md): incrementally migrate
2121
from `protoc-gen-validate`
@@ -45,9 +45,9 @@ project's [PyPI page](https://pypi.org/project/protovalidate/).
4545

4646
## Usage
4747

48-
### Implementing validation constraints
48+
### Implementing validation rules
4949

50-
Validation constraints are defined directly within `.proto` files. Documentation for adding constraints can be found in
50+
Validation rules are defined directly within `.proto` files. Documentation for adding rules can be found in
5151
the `protovalidate` project [README](https://github.com/bufbuild/protovalidate) and
5252
its [comprehensive docs](https://github.com/bufbuild/protovalidate/tree/main/docs).
5353

0 commit comments

Comments
 (0)