Skip to content

Update README.md#1

Open
amazr wants to merge 1 commit intodevelopfrom
amazr-patch-1
Open

Update README.md#1
amazr wants to merge 1 commit intodevelopfrom
amazr-patch-1

Conversation

@amazr
Copy link
Copy Markdown
Owner

@amazr amazr commented Apr 29, 2025

Before this PR

After this PR

==COMMIT_MSG==
==COMMIT_MSG==

Possible downsides?

Are Docs needed?

Comment thread README.md
@@ -8,6 +8,8 @@
> This SDK is incubating and subject to change.
Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

"Wow, two extra blank lines! Were you trying to create some suspense before the next line? Let's keep it clean and remove those unnecessary lines."

Comment thread README.md
@@ -386,4 +388,4 @@ By default, the logs emitted from within the `compute_modules` library have a le
from compute_modules.logging import set_internal_log_level
Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

"Ah, the classic newline at the end of the file. Some say it's a best practice, others say it's just a way to make the file feel complete. Either way, it's not a big deal, but let's be consistent with the rest of the project."

Comment thread README.md
@@ -8,6 +8,8 @@
> This SDK is incubating and subject to change.
Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

"Why on earth are there two blank lines added here? Are you trying to create an abyss in the README? Please remove these unnecessary lines."

Comment thread README.md
@@ -386,4 +388,4 @@ By default, the logs emitted from within the `compute_modules` library have a le
from compute_modules.logging import set_internal_log_level
Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

"Congratulations, you've managed to forget the newline at the end of the file. This is a basic best practice, please add it back."

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.

1 participant