Merge pull request #63 from aws-beam/fix-edoc-generation

Fix edoc in aws_credentials

Author: onno-vos-dev

.github/workflows/build.yml

@@ -60,3 +60,30 @@ jobs:
       with:
         name: edoc
         path: doc
+  docs:
+    strategy:
+      matrix:
+        platform: [ubuntu-latest]
+        otp-version: [24, 25, 26]
+    runs-on: ${{ matrix.platform }}
+    container:
+      image: erlang:${{ matrix.otp-version }}
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Cache Hex packages
+      uses: actions/cache@v1
+      with:
+        path: ~/.cache/rebar3/hex/hexpm/packages
+        key: ${{ runner.os }}-hex-${{ hashFiles(format('{0}{1}', github.workspace, '/rebar.lock')) }}
+        restore-keys: |
+          ${{ runner.os }}-hex-
+    - name: Cache Dialyzer PLTs
+      uses: actions/cache@v1
+      with:
+        path: ~/.cache/rebar3/rebar3_*.plt
+        key: ${{ runner.os }}-dialyzer-${{ hashFiles(format('{0}{1}', github.workspace, '/rebar.config')) }}
+        restore-keys: |
+          ${{ runner.os }}-dialyzer-
+    - name: Generate docs
+      run: rebar3 ex_doc

src/aws_credentials.erl

@@ -1,5 +1,5 @@
 %% @doc This is the main interface to the library. It provides a function
-%% `get_credentials/0' which should return `Credentials :: map()' or `undefined`.
+%% `get_credentials/0' which should return `Credentials :: map()' or `undefined'.
 %% If undefined, it will attempt to get credentials again after 5 seconds delay.
 %% @end
 -module(aws_credentials).