Skip to content

Commit

Permalink
Remove outdated documentation related to a file object passed to writ…
Browse files Browse the repository at this point in the history
…e_to_markdown()
  • Loading branch information
spier committed Oct 29, 2023
1 parent ae1df11 commit 5c5cd84
Showing 1 changed file with 1 addition and 4 deletions.
5 changes: 1 addition & 4 deletions markdown_writer.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@
average_time_to_close: timedelta,
average_time_to_answer: timedelta,
num_issues_opened: int,
num_issues_closed: int,
file: file object = None
num_issues_closed: int
) -> None:
Write the issues with metrics to a markdown file.
get_non_hidden_columns(
Expand Down Expand Up @@ -90,8 +89,6 @@ def write_to_markdown(
average_time_to_close (datetime.timedelta): The average time to close for the issues.
average_time_to_answer (datetime.timedelta): The average time to answer the discussions.
average_time_in_labels (dict): A dictionary containing the average time spent in each label.
file (file object, optional): The file object to write to. If not provided,
a file named "issue_metrics.md" will be created.
num_issues_opened (int): The number of items that remain opened.
num_issues_closed (int): The number of issues that were closed.
labels (List[str]): A list of the labels that are used in the issues.
Expand Down

0 comments on commit 5c5cd84

Please sign in to comment.