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

Update lib.rs and added few more punctuation marks #13

Merged
merged 5 commits into from
Oct 17, 2024

Conversation

KesharwaniArpita
Copy link
Contributor

Contributor checklist


Description

This pull request enhances the allowed_keys function by adding support for a comprehensive set of punctuation marks and special characters. The function previously handled only a limited selection of punctuation, such as commas and semicolons. This update improves the coverage of punctuation, allowing the function to return characters like apostrophes, periods, exclamation marks, and more.

  1. Enhances text and command input functionality by ensuring that all common punctuation marks are recognized and processed.
  2. Ensures a more complete user experience when handling textual data, especially in cases requiring punctuation.

Related issue

Copy link

github-actions bot commented Oct 8, 2024

Thank you for the pull request!

The Scribe team will do our best to address your contribution as soon as we can. The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

If you're not already a member of our public Matrix community, please consider joining! We'd suggest using Element as your Matrix client, and definitely join the General and Desktop rooms once you're in. Also consider joining our bi-weekly Saturday dev syncs. It'd be great to have you!

Maintainer checklist

  • The commit messages for the remote branch should be checked to make sure the contributor's email is set up correctly so that they receive credit for their contribution

    • The contributor's name and icon in remote commits should be the same as what appears in the PR
    • If there's a mismatch, the contributor needs to make sure that the email they use for GitHub matches what they have for git config user.email in their local Scribe-Desktop repo
  • The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)

@andrewtavis andrewtavis added the hacktoberfest Included as a part of Hacktoberfest label Oct 9, 2024
@andrewtavis
Copy link
Member

Hey @RyanPaulGannon, would you have a moment to do an initial review here? :)

@RyanPaulGannon
Copy link
Collaborator

Hey @KesharwaniArpita! Thanks for the PR, there's a few lines here that aren't compiling but it's because it's not part of the Key enum :)

If you take a look at this link, you'll be able to correct the lines and resubmit :)

If you need any help, give me a shout!

scribe/src/lib.rs Outdated Show resolved Hide resolved
scribe/src/lib.rs Outdated Show resolved Hide resolved
scribe/src/lib.rs Outdated Show resolved Hide resolved
scribe/src/lib.rs Outdated Show resolved Hide resolved
@RyanPaulGannon
Copy link
Collaborator

Please review comments and refer to the rdev crate please. There are still a few variants used that aren't included in the enum which is causing the program to not complie.

Please run:

cargo build
cargo run --bin scribe

before committing so you can check to see that the program works first :)

@RyanPaulGannon
Copy link
Collaborator

Thanks for updating, however there are still some errors causing the compilation error. Please run the commands I have listed in my previous comment and make the changes identified by cargo, if you need any help then please ask. Please don't push commits without checking the compilation works correctly :)
Screenshot 2024-10-17 at 16 32 24

@KesharwaniArpita
Copy link
Contributor Author

@RyanPaulGannon I am so sorry for the inconvenience. That surely wasn't the intention. It should work fine now.
Can you help me with one more thing? While trying to run

cargo build
cargo run --bin scribe

I keep on getting the following error and I can't figure out what is causing them. Is there anything missing in the contributing.md ? or anything that you think I might have missed?
image

@RyanPaulGannon
Copy link
Collaborator

Don't worry at all, the PR is looking great now - thank you!
Okay, so I guess I've assumed everyone contributing would have cargo installed - my bad. You'll have to follow these instructions to ensure you have Rust and cargo installed to your machine; it's the build tool for Rust :)

Thank you for highlighting this as we'll need to add it to the contributing.md :)

Copy link
Collaborator

@RyanPaulGannon RyanPaulGannon left a comment

Choose a reason for hiding this comment

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

Looking good, I'm happy that this satisfies #11! Eventually, there will need more work doing regarding punctuation, however, it'll be done alongside implementing the Shift key to allow for capitalisation and general shifting of keys.

@andrewtavis
Copy link
Member

Nice I'll check the docs to make sure the notes on Cargo are explicit (enough) :)

@RyanPaulGannon
Copy link
Collaborator

If you would like me to make the PR for it, I can do - just let me know, I know you're a busy man!

@andrewtavis
Copy link
Member

Ya that actually would be really nice, @RyanPaulGannon :) Thank you!

Copy link
Member

@andrewtavis andrewtavis left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution, @KesharwaniArpita, and also for the review, @RyanPaulGannon! 🚀

@andrewtavis andrewtavis merged commit 93b28b3 into scribe-org:main Oct 17, 2024
@andrewtavis andrewtavis mentioned this pull request Oct 17, 2024
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest Included as a part of Hacktoberfest
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants