Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorder (and restructure) the sections in the README #678

Merged
merged 2 commits into from
Dec 22, 2019
Merged

Reorder (and restructure) the sections in the README #678

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa826b3
Restructure sections in the README
martinholters Nov 16, 2019
c25562f
Sort supported features in README by minimum Compat version
martinholters Dec 21, 2019
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
24 changes: 5 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,12 @@ 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.

## Supported syntax
## Supported features

Currently, the `@compat` macro supports the following syntaxes:

## Module Aliases
* `Base.Order.ReverseOrdering` has a zero arg constructor [#33736]. (since Compat 3.0.0)

## New functions, macros, and methods
* Function composition now supports multiple functions: `∘(f, g, h) = f ∘ g ∘ h`
and splatting `∘(fs...)` for composing an iterable collection of functions ([#33568]). (since Compat 3.0.0)

* `only(x)` returns the one-and-only element of a collection `x` ([#33129]). (since Compat 2.2.0)

Expand All @@ -59,24 +58,11 @@ Currently, the `@compat` macro supports the following syntaxes:

* `isnothing` for testing if a variable is equal to `nothing` ([#29674]). (since Compat 2.1.0)

* `range` supporting `stop` as positional argument ([#28708]). (since Compat 1.3.0)

* `hasproperty` and `hasfield` ([#28850]). (since Compat 2.0.0)

* `merge` methods with one and `n` `NamedTuple`s ([#29259]). (since Compat 2.0.0)

* `Base.Order.ReverseOrdering` has a zero arg constructor [#33736]. (since Compat 3.0.0)

## Renaming

## New macros

## Other changes

* Function composition now supports multiple functions: `∘(f, g, h) = f ∘ g ∘ h`
and splatting `∘(fs...)` for composing an iterable collection of functions ([#33568]). (since Compat 3.0.0)

## New types
* `range` supporting `stop` as positional argument ([#28708]). (since Compat 1.3.0)

## Developer tips

Expand Down