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

in interfaces.rst, replace "brackets" by "parentheses" #4880

Closed
andreas-roehler opened this issue Jul 28, 2020 · 3 comments
Closed

in interfaces.rst, replace "brackets" by "parentheses" #4880

andreas-roehler opened this issue Jul 28, 2020 · 3 comments

Comments

@andreas-roehler
Copy link

docs/tutorial/interfaces.rst, line 147

mentions brackets, where no brackets are shown. Suggest using "parentheses" instead.

Now: Multiple constraints are written in brackets in a comma

separated list, for example:

.. code-block:: idris

sortAndShow : (Ord a, Show a) => List a -> String
sortAndShow xs = show (sort xs)

Should read: Multiple constraints are written in parentheses in a comma

separated list, for example:

.. code-block:: idris

sortAndShow : (Ord a, Show a) => List a -> String
sortAndShow xs = show (sort xs)

Observed Behavior

@zenntenn
Copy link
Contributor

The ( ) symbols are "brackets".

@andreas-roehler
Copy link
Author

Hmm, understanding [ ] as brackets, { } as braces and ( ) as parentheses.

@jfdm
Copy link
Contributor

jfdm commented Aug 27, 2020

Just to say that you are both correct. It depends on if you are using British English or non-British English.

However, it is good to be clear in what we mean, and it would be good to be clearer in this regard. That is we change it to parentheses or to "round brackets".

I am happy to merge a PR offering better disambiguation here.

@jfdm jfdm reopened this Aug 27, 2020
@jfdm jfdm closed this as completed in 89c7c29 Aug 28, 2020
jfdm added a commit that referenced this issue Aug 28, 2020
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

No branches or pull requests

3 participants