Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
daniel-sanche committed Sep 13, 2024
1 parent 37c3226 commit 54ee3be
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions .cross_sync/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,10 @@ Additionally, CrossSync provides method implementations that work equivalently i
CrossSync provides a set of annotations to mark up async classes, to guide the generation of sync code.

- `@CrossSync.export_sync`
- marks classes for conversion, along with an output file path
- marks classes for conversion. Unmarked classes will be droppd
- if add_mapping is included, the async and sync classes can be accessed using a shared CrossSync.X alias
- `@CrossSync.convert`
- marks async functions for conversion
- marks async functions for conversion. Unmarked methods will be copied as-is
- `@CrossSync.drop_method`
- marks functions that should not be included in sync output
- `@CrossSync.pytest`
Expand Down

0 comments on commit 54ee3be

Please sign in to comment.