Skip to content

Commit

Permalink
Reorder (and restrcuture) the sections in the README
Browse files Browse the repository at this point in the history
Previously, the sections were
* Supported syntax
* Module Aliases
* New functions, macros, and methods
* Renaming
* New macros
* Other changes
* New types
* Developer tips

This changes the order to
* Supported syntax
* New functions and methods
* New macros
* New types
* Renaming
* Other changes
* Developer tips

getting rid of the ambiguity where to put new macros and removing the
"Module Aliases" section (if needed, these could probably go into
"Renaming").

Also, the entry from #668 is moved from "Other changes" to "New
functions and methods" as it is a new method.

Finally, presently empty sections get a "None." placeholder entry.
  • Loading branch information
martinholters committed Nov 16, 2019
1 parent 0e84461 commit 5b3bb60
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,12 @@ Please check the list below for the specific syntax you need.

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

## Module Aliases
None.

## New functions, macros, and methods
## New functions 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]).

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

Expand All @@ -65,16 +68,21 @@ Currently, the `@compat` macro supports the following syntaxes:

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

## New macros

None.

## New types

None.

## Renaming

## New macros
None.

## 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]).

## New types
None.

## Developer tips

Expand Down

0 comments on commit 5b3bb60

Please sign in to comment.