-
-
Notifications
You must be signed in to change notification settings - Fork 3.5k
New FES Contributor Docs + FES Survey Link #5460
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
Conversation
…tor-rem-method fix: Update the rem instance method to be chainable
@outofambit @Qianqianye: These files are ready to be reviewed! I will also let my mentors know about this update. |
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.
Hi Alice, this looks like great progress! The main thing I'd want to see addressed before a merge is having an introduction or short technical overview of the FES functions in the contributor docs. Most other things I've noted are just questions that I have or suggestions for future work.
Updated reflecting feedback from @kjhollen, thank you for the great feedback!
|
@Qianqianye @outofambit I'm planning to merge this by the end of the day! |
This PR contains the final drafts for the new FES contributor docs + updated FES inline docs.
Changes:
friendly_error_system.md
doc is now splitted into two parts:friendly_error_system.md
+fes_reference_dev_notes.md
.friendly_error_system.md
: completely re-written with a focus on the error message writing and the internationalization effort.friendly_error_system.md
: link for FES 2021 Survey added.fes_reference_dev_notes.md
: dev notes + technical details. The "Thoughts for Future Work" section will be updated in the next round, based on results from the FES survey (~early 2022).core/friendly_errors
: inline docs are re-organized. Some functions' inline docs now describe their connection to the translation files. Helpful but long inline comments were moved tofes_reference_dev_notes.md
.PR Checklist
npm run lint
passes