Update documentation on deprecations
This commit is contained in:
parent
f9554ec463
commit
9e5ac6eb06
2 changed files with 87 additions and 14 deletions
48
README.md
48
README.md
|
@ -4,17 +4,51 @@ revbank - Banking for hackerspace visitors
|
||||||
|
|
||||||
# ANNOUNCEMENTS
|
# ANNOUNCEMENTS
|
||||||
|
|
||||||
|
The following features were removed:
|
||||||
|
|
||||||
|
- plugins `nyan` and `game`
|
||||||
|
|
||||||
|
Please remove these from your `revbank.plugins` configuration file.
|
||||||
|
|
||||||
|
- creating new accounts with <Cdeposit>
|
||||||
|
|
||||||
|
Use `adduser` instead.
|
||||||
|
|
||||||
|
- Method `$cart->is_multi_user`
|
||||||
|
- Method `$cart->delete($user, $index)`
|
||||||
|
|
||||||
|
Delete a specific entry, as returned by `$cart->entries`, instead.
|
||||||
|
|
||||||
The following will disappear in a future version:
|
The following will disappear in a future version:
|
||||||
|
|
||||||
## Deprecated: creating new accounts with `deposit`
|
## Hooks `add` and `added`
|
||||||
|
|
||||||
For a while now, there has been a dedicated plugin, `adduser` to create new
|
Use `add_entry` and `added_entry` instead, which gets a RevBank::Cart::Entry
|
||||||
accounts. The old way of creating new accounts (unknown input after a
|
object, instead.
|
||||||
`deposit` command was assumed to be the name of the a account) did not allow
|
|
||||||
for any input validation and would cause trouble if a user name already
|
|
||||||
existed.
|
|
||||||
|
|
||||||
Please add `adduser` to `revbank.plugins`.
|
Note that the new "entries", unlike old "items", can have a `quantity` other
|
||||||
|
than 1.
|
||||||
|
|
||||||
|
## Method `$cart->add(undef, ...)`
|
||||||
|
|
||||||
|
## Method `$cart->add($user, ...)`
|
||||||
|
|
||||||
|
The `add` method now always creates an entry from the perspective of the
|
||||||
|
current user, and returns a RevBank::Cart::Entry object to which "contras" can
|
||||||
|
be added with `add_contra`. The contras can be used for counteracting a value
|
||||||
|
with an operation on another account.
|
||||||
|
|
||||||
|
To upgrade a plugin that does a single `add` with `undef` as the first
|
||||||
|
argument, simply remove the `undef, `. When multiple items were added that
|
||||||
|
belong together, consider using `add_contra` for the subsequent lines; see the
|
||||||
|
`take` and `give` plugins for examples.
|
||||||
|
|
||||||
|
## Method `$cart->select_items`
|
||||||
|
|
||||||
|
Use `entries` instead, which takes the same kind of argument. Note that
|
||||||
|
entries work slightly differently: they can have a quantity and attached contra
|
||||||
|
entries. Attributes are now accessed through the `has_attribute` and
|
||||||
|
`attribute` methods, instead of directly manipulating the hash.
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
|
|
||||||
|
|
53
revbank
53
revbank
|
@ -256,17 +256,56 @@ revbank - Banking for hackerspace visitors
|
||||||
|
|
||||||
=head1 ANNOUNCEMENTS
|
=head1 ANNOUNCEMENTS
|
||||||
|
|
||||||
|
The following features were removed:
|
||||||
|
|
||||||
|
=over
|
||||||
|
|
||||||
|
=item * plugins C<nyan> and C<game>
|
||||||
|
|
||||||
|
Please remove these from your C<revbank.plugins> configuration file.
|
||||||
|
|
||||||
|
=item * creating new accounts with <Cdeposit>
|
||||||
|
|
||||||
|
Use C<adduser> instead.
|
||||||
|
|
||||||
|
=item * Method C<< $cart->is_multi_user >>
|
||||||
|
|
||||||
|
=item * Method C<< $cart->delete($user, $index) >>
|
||||||
|
|
||||||
|
Delete a specific entry, as returned by C<< $cart->entries >>, instead.
|
||||||
|
|
||||||
|
=back
|
||||||
|
|
||||||
The following will disappear in a future version:
|
The following will disappear in a future version:
|
||||||
|
|
||||||
=head2 Deprecated: creating new accounts with C<deposit>
|
=head2 Hooks C<add> and C<added>
|
||||||
|
|
||||||
For a while now, there has been a dedicated plugin, C<adduser> to create new
|
Use C<add_entry> and C<added_entry> instead, which gets a RevBank::Cart::Entry
|
||||||
accounts. The old way of creating new accounts (unknown input after a
|
object, instead.
|
||||||
C<deposit> command was assumed to be the name of the a account) did not allow
|
|
||||||
for any input validation and would cause trouble if a user name already
|
|
||||||
existed.
|
|
||||||
|
|
||||||
Please add C<adduser> to C<revbank.plugins>.
|
Note that the new "entries", unlike old "items", can have a C<quantity> other
|
||||||
|
than 1.
|
||||||
|
|
||||||
|
=head2 Method C<< $cart->add(undef, ...) >>
|
||||||
|
|
||||||
|
=head2 Method C<< $cart->add($user, ...) >>
|
||||||
|
|
||||||
|
The C<add> method now always creates an entry from the perspective of the
|
||||||
|
current user, and returns a RevBank::Cart::Entry object to which "contras" can
|
||||||
|
be added with C<add_contra>. The contras can be used for counteracting a value
|
||||||
|
with an operation on another account.
|
||||||
|
|
||||||
|
To upgrade a plugin that does a single C<add> with C<undef> as the first
|
||||||
|
argument, simply remove the C<undef, >. When multiple items were added that
|
||||||
|
belong together, consider using C<add_contra> for the subsequent lines; see the
|
||||||
|
C<take> and C<give> plugins for examples.
|
||||||
|
|
||||||
|
=head2 Method C<< $cart->select_items >>
|
||||||
|
|
||||||
|
Use C<< entries >> instead, which takes the same kind of argument. Note that
|
||||||
|
entries work slightly differently: they can have a quantity and attached contra
|
||||||
|
entries. Attributes are now accessed through the C<has_attribute> and
|
||||||
|
C<attribute> methods, instead of directly manipulating the hash.
|
||||||
|
|
||||||
=head1 DESCRIPTION
|
=head1 DESCRIPTION
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue