Skip to content

converted desc to sentence case - #5926

Merged
eldadfux merged 3 commits into
appwrite:masterfrom
Dksie09:sentence-case
Sep 27, 2023
Merged

eldadfux merged 3 commits into
appwrite:masterfrom
Dksie09:sentence-case

Conversation

@Dksie09

@Dksie09 Dksie09 commented Aug 1, 2023

Copy link
Copy Markdown
Contributor

What does this PR do?

Convert descriptions from title case to sentence case

Test Plan

Manual inspection

Related PRs and Issues

  • (Related PR or issue)

Checklist

  • Have you read the Contributing Guidelines on issues?
  • If the PR includes a change to an API's metadata (desc, label, params, etc.), does it also include updated API specs and example docs?

@Haimantika Haimantika left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Took a quick look. LGTM!


App::put('/v1/account/sessions/magic-url')
->desc('Create Magic URL session (confirmation)')
->desc('Create magic URL session (confirmation)')

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Not related to this PR, @Dksie09 please ignore message below.

What do y'all think about just calling this Confirm magic URL session. Like why did we use brackets?


App::patch('/v1/account/sessions/:sessionId')
->desc('Update OAuth Session (Refresh Tokens)')
->desc('Update OAuth session (refresh tokens)')

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@Dksie09 ignore this
Ditto this, why did we go with brackets 👀

Comment thread app/controllers/api/databases.php Outdated
App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/datetime')
->alias('/v1/database/collections/:collectionId/attributes/datetime', ['databaseId' => 'default'])
->desc('Create DateTime Attribute')
->desc('Create dateTime attribute')

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
->desc('Create dateTime attribute')
->desc('Create datetime attribute')


App::post('/v1/graphql/mutation')
->desc('GraphQL Endpoint')
->desc('GraphQL endpoint')

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@abnegate Should this have a better desc?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yep we could add some more detail here, could be particularly useful since it ends up in SDK docblocks

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I've added a task for this. We'll address these separately to avoid scope creep.

Comment thread app/controllers/api/health.php Outdated

App::get('/v1/health')
->desc('Get HTTP')
->desc('Get http')

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
->desc('Get http')
->desc('Get HTTP')

Comment thread app/controllers/api/health.php Outdated

App::get('/v1/health/db')
->desc('Get DB')
->desc('Get db')

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
->desc('Get db')
->desc('Get DB')

@gewenyu99 gewenyu99 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@eldadfux
eldadfux merged commit 59a850d into appwrite:master Sep 27, 2023

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

@Dksie09

![IMG_20231003_075205](https://github.com/appwrite/appwrite/assets/146800834/e90acb04-f91e-4ce9-94aa-ac3ac8a05a50)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

No open projects
Status: Done

Development

Successfully merging this pull request may close these issues.

6 participants