~tyil/raku-hash-merge

86cc162923350599eb513aa0ae29d9e748b6ff78 — Patrick Spek 4 years ago 5849c96
Rewrite README
3 files changed, 60 insertions(+), 12 deletions(-)

M CHANGELOG.md
D README.md
A README.rakudoc
M CHANGELOG.md => CHANGELOG.md +10 -0
@@ 1,4 1,5 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)


@@ 21,15 22,24 @@ Versioning](http://semver.org/spec/v2.0.0.html).
  is no longer modified itself, which could cause some awkward bugs in other
  programs.

- The README has been rewritten in Pod6.

## [1.0.0] - 2018-03-28

### Added

- `:api` key in `META6.json`

- New `Hash::Merge` that exposes subs instead of augmenting `Hash`

### Changed

- Old `Hash::Merge` functionality moved to `Hash::Merge::Augment`

## [0.2.0] - 2018-03-14

### Added

- `LICENSE` file for Artistic License 2.0 ([GitHub#2](https://github.com/scriptkitties/p6-Hash-Merge/issues/2))

- `no precompilation` pragma ([GitHub#1](https://github.com/scriptkitties/p6-Hash-Merge/issues/1))

D README.md => README.md +0 -12
@@ 1,12 0,0 @@
[![Build Status](https://travis-ci.org/scriptkitties/p6-Hash-Merge.svg?branch=master)](https://travis-ci.org/scriptkitties/p6-Hash-Merge)

### method merge

```perl6
method merge(
    %b,
    Bool:D :$no-append-array = Bool::False
) returns Mu
```

Merges a second hash into the hash the method is called on. Hash given as the argument is not modified. Traverses the full tree, replacing items in the original hash with the hash given in the argument. Does not replace positional elements by default, and instead appends the items from the supplied hash's array to the original hash's array. The object type of positionals is not retained and instead becomes an Array type. Use :no-append-array to replace arrays and positionals instead, which will also retain the original type and not convert to an Array

A README.rakudoc => README.rakudoc +50 -0
@@ 0,0 1,50 @@
=begin pod

=NAME    Log
=VERSION 1.0.0
=AUTHOR  Patrick Spek <p.spek+raku@tyil.nl>

=head1 Description

A module for the Raku programming language to easily deep-merge two hashes.

=head2 Usage

	my %alpha =
		a => 'b',
		c => {
			d => 'e',
			f => 'g',
		},
	;

	my %beta =
		z => 'y',
		c => {
			x => 'w',
		},
	;

	my %merged = merge-hash(%alpha, %beta);

=head2 Documentation

There's currently no extensive documentation available.

=head2 Contributing

The module's source code is available at the following locations:

=item L<https://gitlab.com/tyil/raku-hash-merge>
=item L<https://github.com/scriptkitties/p6-Hash-Merge>

If you have a change you would like to include, please send a patch to
L<mailto:~tyil/raku-devel@lists.sr.ht>.

=head2 License

This module is distributed under the terms of the Artistic License 2.0. For
more information, consult the LICENSE file in the module's source code
repository.

=end pod