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.

Sign up for GitHub

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

Jump to bottom

Update error-handling.md #988

Merged
merged 1 commit into from
Jul 12, 2022
Merged

Update error-handling.md #988

merged 1 commit into from
Jul 12, 2022

Conversation

SteveFunso
Copy link
Contributor

I propose an update on line 66 at the point where it says "... but their name should be camel-cased to be used by Strapi", I suggest that the qualifier "lower" should be added to the camel-cased as edited above. I believe this bring bring more clarity to what type of camel-case (of the two types: The upper camel-case and the lower camel-case ) is being referred to as expected here,

What does it do?

Describe the technical changes you did.

Why is it needed?

Describe the issue you are solving.

Related issue(s)/PR(s)

Let us know if this is related to any issue/pull request

@SteveFunso
Update error-handling.md
b306273 
I propose an update on line 66 at the point where it says  "... but their name should be camel-cased to be used by Strapi", I suggest that the qualifier "lower" should be added to the camel-cased as edited above. I believe this bring bring more clarity to what type of camel-case (of the two types: The upper camel-case and the lower camel-case ) is being referred to as expected here,
@strapi-cla
Copy link

strapi-cla commented Jul 8, 2022 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@vercel
Copy link

vercel bot commented Jul 8, 2022 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
documentation ✅ Ready (Inspect) Visit Preview Jul 8, 2022 at 2:10AM (UTC)

pwizla
pwizla approved these changes Jul 8, 2022
View reviewed changes
Copy link
Collaborator

@pwizla pwizla left a comment

Choose a reason for hiding this comment

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

Thank you very much @SteveFunso, this is a nice addition that would be helpful to readers 🤗
Could you please try to sign the CLA before I can merge it?

@pwizla pwizla self-assigned this Jul 8, 2022
@pwizla pwizla added source: Dev Docs PRs/issues targeting the Developer Docs pr: updated content PRs updating existing documentation content target: v4 Documentation PRs/issues targeting content from docs.strapi.io (main branch). size: small If the PR includes only 1 file with <10 lines of text or a small code fix labels Jul 8, 2022
@derrickmehaffy
Copy link
Member

Can you clarify what you mean by upper and lower? Else are you referring to PascelCase instead of camelCase? To my knowledge upper/lower camelCase doesn't exist.

You have the common 4:

  • camelCase
  • PascelCase
  • snake_case
  • kebab-case

@pwizla
Copy link
Collaborator

pwizla commented Jul 9, 2022 •
edited
Loading

Can you clarify what you mean by upper and lower? Else are you referring to PascelCase instead of camelCase? To my knowledge upper/lower camelCase doesn't exist.

You have the common 4:

* camelCase

* PascelCase

* snake_case

* kebab-case

To my knowledge, @derrickmehaffy, the camel case family includes both upper camel case, also known as PascalCase (as in ThisIsAnExample), and lower camel case (as in thisIsAnotherExample), which we more commonly simply call camel case. I think it doesn't hurt to be very specific, as some organizations make the distinction.

Multiple sources over the web, citing for instance Wikipedia, this other Wiki, or even Python docs.

Fun fact: for disambiguation, (lower) camel case should actually be called "dromedary" case as dromedaries have only one hump, while camels have 2 😄
Screenshot 2022-07-09 at 10 55 50

@SteveFunso
Copy link
Contributor Author

lower

Thanks @pwizla

@pwizla pwizla added this to the 4.2.3 milestone Jul 12, 2022
@pwizla pwizla changed the base branch from main to release/4-2-3 July 12, 2022 16:00
@pwizla
Copy link
Collaborator

pwizla commented Jul 12, 2022

FYI @SteveFunso I've updated the target branch as this contribution will deployed as part of the 4.2.3 milestone 🙂

@pwizla pwizla merged commit 08d3625 into strapi:release/4-2-3 Jul 12, 2022
@pwizla pwizla mentioned this pull request Jul 12, 2022
Merged
5 tasks
@SteveFunso
Copy link
Contributor Author

Thank you @pwizla

@SteveFunso SteveFunso deleted the patch-1 branch July 12, 2022 22:09
pwizla added a commit that referenced this pull request Jul 13, 2022
@pwizla @SteveFunso
@Convly @vcoisne @gpene @stb13579
🧐 Release 4.2.3 to staging (#993)
10dac5b 
* Update error-handling.md (#988)

camel case → lower camel case

* Bump to version 4.2.3

* Add warning callout for enum values (#984)

* Add warning callout for enum values

* Update wording to be more specific (dev feedback)

Co-authored-by: Jean-Sébastien Herbaux <[email protected]>

* Downgrade callout from danger to caution

Co-authored-by: Jean-Sébastien Herbaux <[email protected]>

* update link to public roadmap (#990)

* update link to public roadmap

From Product Board to Canny

* Update wording "our" → "the"

Co-authored-by: Pierre Wizla <[email protected]>

* Email + Upload Plugins and Providers pages (#992)

* fixed code snippets and added ts config

* added new introduction

* revised wording

* add tabs card

* Add code snippets for providers

* Reorg doc structure

* adds Using Providers page

* fix tabs

* rework text

* start programmatic use section

* Rework the email template section

* various changes

* Add code example for lifecycle hook in admin panel

* add temp links to new providers page

* delete configure the plugin

* change wording about SendMail

* finalize intro topics

* remove unused content

* Cleanup code examples and remove troubleshooting section

* comment out last section for now

* fix grammar

* add html tags to table

* small content edit

* Adding Sentry plugin doc

* fix tables

* fix controller code example

* updated some language

* update lifecycle hook section

* improve spelling an grammar

* improve misc things

* improve the introduction

* update table and misc improvements

* improved lifecycle hook text

* Fix email plugin caps

* fix

* Add missing closing </ul> that prevented VuePress rendering

* add bullet points

* remove unnecessary fragment

* rework intro

* Update based on feedback

* Update upload.md

* improved various parts

* add call out and fix titles

* misc improvements

* simplify wording

* fix code block file paths and header levels

* fixed various parts

* update node engines

* add spaces to empty object braces

* trim content

* shorten send func disc

* feedback updates

* add optional to table

* Add send function properties table

* updated send function table

* add spacing

* Update docs/developer-docs/latest/plugins/email.md

Co-authored-by: Pierre Wizla <[email protected]>

* updated minor wording + delint

* add space

* feedback revisions

* modify `send` properties table

* feedback

* feedback

* revisions

* fix links in admin panel config file

* delint

* minor fixes

* Update docs/developer-docs/latest/development/using-providers.md

Co-authored-by: Shaun Brown  <[email protected]>

* Update docs/developer-docs/latest/plugins/email.md

Co-authored-by: Pierre Wizla <[email protected]>

* Update docs/developer-docs/latest/plugins/email.md

* Feedback

* title fix

* add table

* Add Sentry to PluginLinks component

Co-authored-by: Shaun Brown <[email protected]>
Co-authored-by: Pierre Wizla <[email protected]>
Co-authored-by: Shaun Brown <[email protected]>
Co-authored-by: Pierre Wizla <[email protected]>

* Fix - → —

* Update Email example to include missing path

* Fix broken link

* Fix another broken link

* Update cross-link for compliance with style guide

Co-authored-by: Adegbola Stephen <[email protected]>
Co-authored-by: Jean-Sébastien Herbaux <[email protected]>
Co-authored-by: Victor Coisne <[email protected]>
Co-authored-by: Gabriel <[email protected]>
Co-authored-by: Shaun Brown <[email protected]>
Co-authored-by: Shaun Brown <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pwizla pwizla pwizla approved these changes

Assignees

@pwizla pwizla

Labels
pr: updated content PRs updating existing documentation content size: small If the PR includes only 1 file with <10 lines of text or a small code fix source: Dev Docs PRs/issues targeting the Developer Docs target: v4 Documentation PRs/issues targeting content from docs.strapi.io (main branch).
Projects
None yet
Milestone
4.2.3
Development

Successfully merging this pull request may close these issues.
4 participants
@SteveFunso @strapi-cla @derrickmehaffy @pwizla