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.

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

feat: update readme with json logger details #47

Merged
merged 14 commits into from
Feb 27, 2024

Conversation

RuanJohn
Copy link
Collaborator

What?

Add information about the JSON logger to the readme.

Extra

  • Small changes to JSON tools main readme information
  • Add imports for JSON tools functions in marl_eval/json_tools/__init__.py
  • Add detailed docs for JSON tools.

@RuanJohn RuanJohn requested a review from sash-a February 26, 2024 18:29
@RuanJohn RuanJohn self-assigned this Feb 26, 2024
Copy link
Collaborator

@sash-a sash-a left a comment

Choose a reason for hiding this comment

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

Looks great! Mostly grammatical issues 🚒

README.md Outdated Show resolved Hide resolved
docs/json_tooling_usage.md Outdated Show resolved Hide resolved
docs/json_tooling_usage.md Outdated Show resolved Hide resolved
docs/json_tooling_usage.md Outdated Show resolved Hide resolved
docs/json_tooling_usage.md Show resolved Hide resolved
docs/json_tooling_usage.md Outdated Show resolved Hide resolved
Comment on lines 150 to 153
except zipfile.BadZipFile:
# If the file is not zipped continue to the next file
# as it is already downloaded.
continue
Copy link
Collaborator

Choose a reason for hiding this comment

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

Don't quite follow why we wouldn't also throw this as an error?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This just assumes the file doesn't have to be unzipped. All files are already downloaded before attempting to unzip them, so we just continue. The zipfile.BadZipFile is just a bit misleading.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Ah then can we change the docs: saying its already unzipped instead of already downloaded.

Just checking that it's placed in the same directory as the files that are unzipped?

marl_eval/json_tools/json_utils.py Outdated Show resolved Hide resolved
marl_eval/json_tools/json_utils.py Outdated Show resolved Hide resolved
marl_eval/json_tools/json_utils.py Show resolved Hide resolved
RuanJohn and others added 9 commits February 27, 2024 09:45
Co-authored-by: Sasha <reallysasha@gmail.com>
Co-authored-by: Sasha <reallysasha@gmail.com>
Co-authored-by: Sasha <reallysasha@gmail.com>
Co-authored-by: Sasha <reallysasha@gmail.com>
Co-authored-by: Sasha <reallysasha@gmail.com>
Co-authored-by: Sasha <reallysasha@gmail.com>
Co-authored-by: Sasha <reallysasha@gmail.com>
sash-a
sash-a previously approved these changes Feb 27, 2024
Copy link
Collaborator

@sash-a sash-a left a comment

Choose a reason for hiding this comment

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

Very minor things so approving 😄

docs/json_tooling_usage.md Outdated Show resolved Hide resolved
Comment on lines 150 to 153
except zipfile.BadZipFile:
# If the file is not zipped continue to the next file
# as it is already downloaded.
continue
Copy link
Collaborator

Choose a reason for hiding this comment

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

Ah then can we change the docs: saying its already unzipped instead of already downloaded.

Just checking that it's placed in the same directory as the files that are unzipped?

Co-authored-by: Sasha <reallysasha@gmail.com>
Copy link
Collaborator

@sash-a sash-a left a comment

Choose a reason for hiding this comment

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

🔢

@RuanJohn RuanJohn merged commit c1c2664 into main Feb 27, 2024
3 checks passed
@RuanJohn RuanJohn deleted the feat/update-readme-with-logger-details branch February 27, 2024 08:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants