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

Wrap unique() in double quotes to better indicate that it's a literal… #2600

Merged
merged 1 commit into from Jan 17, 2022

Conversation

gewenyu99
Copy link
Contributor

… string

What does this PR do?

In the documentation, many endpoints allow the string "unique()" to be used to indicate that a random uuid should be generated. Currently, the documentation displays "unique()" as plain text.

Screen Shot 2022-01-12 at 3 56 55 PM

This can mislead readers (like myself), to think that there is a function unique() to generate a uuid on the client side. The current approach in the documentation uses single ` signs around unique to indicate a code block, but it does not get rendered in the actual docs.

The proposed fix, wrapping unique() in double quotes, is a temporary fix to clearly indicate that it's a string. A more permanent fix would be to fix the rendering of inline code snippets in the docs.

https://appwrite.io/docs/server/functions

Related PRs and Issues

None that I know of

Have you read the [Contributing Guidelines on issues]

Yes :D

Copy link
Member

@eldadfux eldadfux left a comment

Choose a reason for hiding this comment

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

LGTM

I think we might want to consider a built in class like we have for Query, but it will be a bit harder to explain this across different languages as syntax can be 100% the same.

cc @lohanidamodar

@gewenyu99 gewenyu99 marked this pull request as ready for review January 17, 2022 15:19
@eldadfux eldadfux merged commit f5bf1a3 into appwrite:master Jan 17, 2022
@eldadfux
Copy link
Member

@gewenyu99 congrats on your first appwrite/appwrite PR!! 🥳

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants