Skip to content

Commit

Permalink
chore: add docstring, remove unused kwargs
Browse files Browse the repository at this point in the history
  • Loading branch information
iliastsa committed Feb 27, 2024
1 parent c8d783d commit 4a3acf4
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion crytic_compile/crytic_compile.py
Original file line number Diff line number Diff line change
Expand Up @@ -637,7 +637,10 @@ def _compile(self, **kwargs: str) -> None:
for source_unit in compilation_unit.source_units.values():
source_unit.remove_metadata()

def compile(self, **kwargs: str) -> None:
def compile(self) -> None:
"""Compile the project. The kwargs provided during object initialization will be used.
This function is useful when paired with the `crytic_defer_compilation` kwargs option.
"""
return self._compile(**self.compilation_kwargs)

@staticmethod
Expand Down

0 comments on commit 4a3acf4

Please sign in to comment.