Skip to content

Commit b767311

Browse files
committed
fix: Fix documentation for the build function in the go workflow
1 parent c15c6b0 commit b767311

File tree

2 files changed

+1
-24
lines changed

2 files changed

+1
-24
lines changed

aws_lambda_builders/workflows/go_modules/DESIGN.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ will be one public method `build`, which takes the provided arguments and
1616
builds a static binary using standard go tools.
1717

1818
```python
19-
def build(self, source_dir_path, artifacts_dir_path, ui=None, config=None):
19+
def build(self, source_dir_path, artifacts_dir_path, executable_name):
2020
"""Builds a go project into an artifact directory.
2121
2222
:type source_dir_path: str
@@ -27,18 +27,6 @@ def build(self, source_dir_path, artifacts_dir_path, ui=None, config=None):
2727
2828
:type executable_name: str
2929
:param executable_name: Name of the executable to create from the build.
30-
31-
:type ui: :class:`lambda_builders.utils.UI` or None
32-
:param ui: A class that traps all progress information such as status
33-
and errors. If injected by the caller, it can be used to monitor
34-
the status of the build process or forward this information
35-
elsewhere.
36-
37-
:type config: :class:`lambda_builders.utils.Config` or None
38-
:param config: To be determined. This is an optional config object
39-
we can extend at a later date to add more options to how modules is
40-
called.
41-
"""
4230
```
4331
4432
### Implementation

aws_lambda_builders/workflows/go_modules/builder.py

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,6 @@ def build(self, source_dir_path, artifacts_dir_path, executable_name):
3535
3636
:type executable_name: str
3737
:param executable_name: Name of the executable to create from the build.
38-
39-
:type ui: :class:`lambda_builders.utils.UI` or None
40-
:param ui: A class that traps all progress information such as status
41-
and errors. If injected by the caller, it can be used to monitor
42-
the status of the build process or forward this information
43-
elsewhere.
44-
45-
:type config: :class:`lambda_builders.utils.Config` or None
46-
:param config: To be determined. This is an optional config object
47-
we can extend at a later date to add more options to how modules is
48-
called.
4938
"""
5039
env = {}
5140
env.update(self.osutils.environ)

0 commit comments

Comments
 (0)