summaryrefslogtreecommitdiff
path: root/API.md
diff options
context:
space:
mode:
authorWuzzy <almikes@aol.com>2016-11-17 18:43:29 +0100
committerWuzzy <almikes@aol.com>2016-11-17 18:43:29 +0100
commit66cb0a4a8ca8a04dd3509ead7db8932ea9df5aa4 (patch)
tree585bd61215fcb1e6264b78ca0297976b421501bf /API.md
parent1cd11eadbbdf7a91680a479566990e26c66d4a14 (diff)
Require API programmer to check category before adding alias
Diffstat (limited to 'API.md')
-rw-r--r--API.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/API.md b/API.md
index 87c2c18..4ee0635 100644
--- a/API.md
+++ b/API.md
@@ -335,6 +335,7 @@ Always `nil`.
Adds a single alias for an entry. When an entry has an alias, supplying the
alias to a function which demands an `entry_id` will work as if the original
`entry_id` has been supplied. Aliases are true within one category only.
+When using this function, you must make sure the category already exists.
#### Parameters
* `category_id`: Category identifier of the category of the entry in question
@@ -348,6 +349,7 @@ Always `nil`.
### `doc.add_entry_aliases(category_id, entry_id, aliases)`
Adds an arbitrary amount of aliases for an entry at once. Apart from that, this
function has the same effect as `doc.add_entry_alias`.
+When using this function, you must make sure the category already exists.
#### Parameters
* `category_id`: Category identifier of the category of the entry in question