-
Notifications
You must be signed in to change notification settings - Fork 908
Add-FAQ-to-README #344
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
Add-FAQ-to-README #344
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks so much, @athenaozanich for the contributions! Apologies it took me so late to look at this (no idea how I missed it). Very nice to create this PR, and thank you for sharing this FAQ for others!
Most of the changes here are minor or just make the FAQ sound more professional, let me know if there are questions or anything is unclear.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: this reads a little odd, could change to "being stored" or just have it say "sent"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: "and/or" but I would probably just rephrase that whole sentence to "If your data is in the wrong order..."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
spelling: "effective"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
in-line code callouts are just one back-tick rather than three.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
spelling/grammar: "its" since it is not a contraction for "it is" in this context
@athenaozanich - would you be able to make some of the brief changes above? If not, anyone could probably add another commit that does this in a new PR. Thank you!
I'll create a new PR (#398) to resolve the concerns & get the changes here merged in :) thanks for your contribution!!
* Add-FAQ-to-README * Address Sean's code review feedback for FAQ (#344) Co-authored-by: athenaozanich <athenaozanich@gmail.com>
Added brief description of how to troubleshoot the issue of incorrect data ordering, using the suggested steps provided by @mckennapsean