Skip to content

Commit

Permalink
Explain the compat workflow for functions (#827)
Browse files Browse the repository at this point in the history
* Explain the compat workflow for functions

* Separate syntax from functions
  • Loading branch information
gdalle authored Jun 24, 2024
1 parent 8fa46c0 commit f8af0d1
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,14 @@ and then as needed add
@compat ...compat syntax...
```

wherever you want to use syntax that differs in the latest Julia
wherever you want to use _syntax_ that differs in the latest Julia
`master` (the development version of Julia). The `compat syntax` is usually
the syntax on Julia `master`. However, in a few cases where this is not possible,
a slightly different syntax might be used.
Please check the list below for the specific syntax you need.

Note that if you want to use a _function_ `new_f` defined in later Julia versions, it is redefined in Compat (as `Compat.new_f`) and exported, so you don't need to change anything to your code beyond the initial import.

## Compatibility

Features in the development versions of `julia` may be added and released in
Expand Down

0 comments on commit f8af0d1

Please sign in to comment.