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

Fixed typo at line 340 of README.md #1791

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Victoran0
Copy link

Under the Chat Completion section, about the fourth line under it, we have: 'The model will will format the messages into a single prompt using the following order of precedence:'...
'will' appeared twice, this update fix that.

Copy link
Contributor

@lukestanley lukestanley left a comment

Choose a reason for hiding this comment

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

The commit message / PR title could better match what it is! Deleting the typo / grammar issue has nothing to do with cuda.

@Victoran0
Copy link
Author

The commit message / PR title could better match what it is! Deleting the typo / grammar issue has nothing to do with cuda.

Oops, sorry about that, I did use the same message as the latest commit the readme.md file has, with the additional (updated) at the end. That is because i thought the new commit is not a new feature, only fixing a typographical error.
However, I have edited the commit message in a new commit.

@Victoran0 Victoran0 changed the title docs: Add cuda 12.5 to README.md (updated). Typo at line 340 fixed Oct 15, 2024
@lukestanley
Copy link
Contributor

lukestanley commented Oct 17, 2024

But now there are 2 commit messages and none of them quite describe what someone would want to know. For example if someone saw the message: "Typo at line 340 fixed", they would think - what file? Then they might go to check the file and see that there is no change there at all. Empty commits are not so helpful.
Instead, you might want to undo your last empty commit, and adjust the commit message in your original commit.
You would probably then want to force push it up to overwrite Victoran0:patch-2 with a better commit message.
@Victoran0

Under the Chat Completion section, about the fourth line under it (line 340), we have: 'The model will will format the messages into a single prompt using the following order of precedence:'...
'will' appeared twice. This update fix that.
@Victoran0 Victoran0 changed the title Typo at line 340 fixed Fixed typo at line 340 of README.md Oct 18, 2024
@Victoran0
Copy link
Author

@lukestanley how does it look now?

Copy link
Contributor

@lukestanley lukestanley left a comment

Choose a reason for hiding this comment

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

It's readable, it matches up with what it does. I think it's acceptable. There is no need to say the line number, but it's okay. It's fairly clean and tidy. In my capacity as a random internet person I approve. 👍 @Victoran0

@Victoran0
Copy link
Author

Victoran0 commented Oct 18, 2024

Thanks for your consideration @lukestanley 👏👏👏

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