From fa826b3cb464dbe45dc758b82dc8665c7909540a Mon Sep 17 00:00:00 2001 From: Martin Holters Date: Sat, 16 Nov 2019 12:00:26 +0100 Subject: [PATCH 1/2] Restructure sections in the README Previously, the sections were * Usage * Supported syntax * Module Aliases * New functions, macros, and methods * Renaming * New macros * Other changes * New types * Developer tips This changes them to just * Usage * Supported features * Developer tips --- README.md | 16 +--------------- 1 file changed, 1 insertion(+), 15 deletions(-) diff --git a/README.md b/README.md index 59f78e03e..9977cfe35 100644 --- a/README.md +++ b/README.md @@ -42,13 +42,7 @@ 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 - -Currently, the `@compat` macro supports the following syntaxes: - -## Module Aliases - -## New functions, macros, and methods +## Supported features * `only(x)` returns the one-and-only element of a collection `x` ([#33129]). (since Compat 2.2.0) @@ -67,17 +61,9 @@ Currently, the `@compat` macro supports the following syntaxes: * `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 - ## Developer tips One of the most important rules for `Compat.jl` is to avoid breaking user code From c25562f18a29d730607ad8d8bb0325efba2a9542 Mon Sep 17 00:00:00 2001 From: Martin Holters Date: Sat, 21 Dec 2019 22:09:52 +0100 Subject: [PATCH 2/2] Sort supported features in README by minimum Compat version --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9977cfe35..f2f287364 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,11 @@ Please check the list below for the specific syntax you need. ## Supported features +* `Base.Order.ReverseOrdering` has a zero arg constructor [#33736]. (since Compat 3.0.0) + +* 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) * `mod` now accepts a unit range as the second argument ([#32628]). (since Compat 2.2.0) @@ -53,16 +58,11 @@ Please check the list below for the specific syntax you need. * `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) - -* 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) +* `range` supporting `stop` as positional argument ([#28708]). (since Compat 1.3.0) ## Developer tips