Skip to content

Commit d3ab9d8

Browse files
committed
Document missing_repo_organization error in get_policy/2 doc
Mention the {error, missing_repo_organization} return so the doc covers both the success and absence-of-config cases.
1 parent d04ce99 commit d3ab9d8

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

src/hex_repo.erl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,8 @@ get_package(Config, Name) when is_binary(Name) and is_map(Config) ->
9494
%%
9595
%% Requires `repo_organization' to be set in the config; policies are
9696
%% always served from the per-organization namespace
97-
%% (`/repos/<organization>/policies/<name>').
97+
%% (`/repos/<organization>/policies/<name>'). Returns
98+
%% `{error, missing_repo_organization}' when it is not set.
9899
%%
99100
%% Examples:
100101
%%

0 commit comments

Comments
 (0)