Skip to content

Commit a6fa78a

Browse files
committed
Add hex doc provider config and improve module documentation
1 parent e0183b2 commit a6fa78a

3 files changed

Lines changed: 14 additions & 0 deletions

File tree

rebar.config

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@
2828

2929
{project_plugins, [rebar3_ex_doc]}.
3030

31+
{hex, [{doc, ex_doc}]}.
32+
3133
{ex_doc, [
3234
{source_url, <<"https://github.com/benoitc/erlang-python">>},
3335
{main, <<"readme">>},

src/erlang_python_app.erl

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
%% See the License for the specific language governing permissions and
1313
%% limitations under the License.
1414

15+
%%% @doc Application callback module for erlang_python.
16+
%%% @private
1517
-module(erlang_python_app).
1618
-behaviour(application).
1719

src/erlang_python_sup.erl

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,16 @@
1212
%% See the License for the specific language governing permissions and
1313
%% limitations under the License.
1414

15+
%%% @doc Top-level supervisor for erlang_python.
16+
%%%
17+
%%% Manages the worker pools for Python execution:
18+
%%% <ul>
19+
%%% <li>py_callback - Callback registry for Python to Erlang calls</li>
20+
%%% <li>py_pool - Main worker pool for synchronous Python calls</li>
21+
%%% <li>py_async_pool - Worker pool for asyncio coroutines</li>
22+
%%% <li>py_subinterp_pool - Worker pool for sub-interpreter parallelism</li>
23+
%%% </ul>
24+
%%% @private
1525
-module(erlang_python_sup).
1626
-behaviour(supervisor).
1727

0 commit comments

Comments
 (0)