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

Syntax Lookup: ignore() function #570

Merged

Conversation

kevanstannard
Copy link
Contributor

@kevanstannard kevanstannard commented Sep 30, 2022

Hi team, suggestion for #162 and #448

@@ -409,33 +409,36 @@ add(1, 2);

</CodeTab>

If you need to call a curried function with a single unit `()` argument, you can use the `ignore()` function:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

🗒️ Looks like this is no longer required for v10?

Copy link
Contributor

Choose a reason for hiding this comment

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

Indeed, plus it should have said "uncurried".

| Decorators
| Operators
| LanguageConstructs
| BuiltInFunctions
Copy link
Contributor Author

Choose a reason for hiding this comment

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

🗒️ New category

Copy link
Contributor

@cristianoc cristianoc left a comment

Choose a reason for hiding this comment

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

This looks great, thanks for that.
Just a question: should this also show up in the overall search?

In other words, it's generally not clear to me when one should reach for the overall search (the one powered by algolia), and when one should reach out for syntax lookup.

@kevanstannard
Copy link
Contributor Author

kevanstannard commented Oct 2, 2022

It's a good question. It was originally inspired by a JS syntax lookup.

Here's how I think about it at the moment:

[1] Syntax Lookup on its own provides a quick reference / cheat sheet of syntax.
[2] Syntax Lookup and Algolia are both kinds of "indexes" to help you locate primary documentation pages.

Since the Syntax Lookup only contains summarised information that is already on the primary documentation pages, perhaps it's not necessary to include in Algolia?

@ryyppy what do you think?

@ryyppy
Copy link
Member

ryyppy commented Oct 2, 2022

LGTM. Regarding Algolia: I think the widget pages should not show up in the search results for the same reasons you just mentioned.

@ryyppy ryyppy merged commit 6078f39 into rescript-lang:master Oct 2, 2022
@kevanstannard kevanstannard deleted the syntax-lookup-ignore-function branch October 2, 2022 23:34
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.

3 participants