Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Output customizations: REPORT_TITLE and OUTPUT_FILE #160

Closed
wants to merge 5 commits into from
Closed

Output customizations: REPORT_TITLE and OUTPUT_FILE #160

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1693462
WIP: First working implementation of a customizable REPORT_TITLE
spier Oct 29, 2023
ae1df11
Lint fixes
spier Oct 29, 2023
5c5cd84
Remove outdated documentation related to a file object passed to writ…
spier Oct 29, 2023
8b227f0
Moving default for REPORT_TITLE to write_to_markdown() signature
spier Oct 31, 2023
98d9842
Remove whitespace
spier Oct 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions markdown_writer.py
View file
Open in desktop
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
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@zkoppert I found these traces in the documentation.

Apparently at some point in the past, a file object was passed to the write_to_markdown().
Do you happen to know anything about this?

As I am looking to add the feature to set a custom OUTPUT_FILE, I don't want to go down an implementation path that might have been already tried in the past (and did not work). :)

Copy link
Contributor Author

@spier spier Oct 31, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding a link to the commit where I removed that unused bit of documentation. GitHub did not give me a straightforward way to get there from my comment above.
5c5cd84

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I think that was aspirational. I don't think we actually wrote the code to support that.

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