Fixing erroneous em dashes - #11844
Open
ConnorLand wants to merge 18 commits into
Open
Conversation
these commits are going to be really boring to name
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| It is possible for a component to extend the defined set of validation rules. A new validator—a function that checks a passed value and returns a validation message string if any—can be provided through the `setValidator` function. A component can have only a single custom validator. The Mendix Platform ensures that custom validators are run whenever necessary, for example when a page is being saved by an end-user. It is best practice to call `setValidator` early in a component's lifecycle—specifically in the [componentDidMount](https://en.reactjs.org/docs/react-component.html#componentdidmount) function. | ||
|
|
||
| In practice, many client components present values as nicely formatted strings which take locale-specific settings into account. To facilitate such cases `EditableValue` exposes a field `displayValue` which is the formatted version of `value`, and a method `setTextValue` — a version of `setValue` that takes care of parsing. `setTextValue` also validates that a passed value can be parsed and assigned to the target's value type. Similarly to `setValue`, a change to an invalid value will not be propagated further than the prop itself, but a `validation` is reported. Note that if a value cannot be parsed, the prop will contain only a `displayValue` string and `value` will become undefined. | ||
| In practice, many client components present values as nicely formatted strings which take locale-specific settings into account. To facilitate such cases `EditableValue` exposes a field `displayValue` which is the formatted version of `value`, and a method `setTextValue`—a version of `setValue` that takes care of parsing. `setTextValue` also validates that a passed value can be parsed and assigned to the target's value type. Similarly to `setValue`, a change to an invalid value will not be propagated further than the prop itself, but a `validation` is reported. Note that if a value cannot be parsed, the prop will contain only a `displayValue` string and `value` will become undefined. |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.Dashes] Remove spaces around the em dash (—). Or, to set off a list item intro or number range, use an en dash (–) instead.
| ##### Built-in Formatter Types {#built-in-formatter-types} | ||
|
|
||
| The Mendix platform provides two typed, configurable built-in formatters that extend `SimpleFormatter<T>`: `NumberFormatter` and `DateTimeFormatter`. The actual type of `EditableValue.formatter` is `ValueFormatter<T>` — a union that covers both built-in and plain formatters: | ||
| The Mendix platform provides two typed, configurable built-in formatters that extend `SimpleFormatter<T>`: `NumberFormatter` and `DateTimeFormatter`. The actual type of `EditableValue.formatter` is `ValueFormatter<T>`—a union that covers both built-in and plain formatters: |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.Dashes] Remove spaces around the em dash (—). Or, to set off a list item intro or number range, use an en dash (–) instead.
| ##### Built-in Formatter Types {#built-in-formatter-types} | ||
|
|
||
| The Mendix platform provides two typed, configurable built-in formatters that extend `SimpleFormatter<T>`: `NumberFormatter` and `DateTimeFormatter`. The actual type of `EditableValue.formatter` is `ValueFormatter<T>` — a union that covers both built-in and plain formatters: | ||
| The Mendix platform provides two typed, configurable built-in formatters that extend `SimpleFormatter<T>`: `NumberFormatter` and `DateTimeFormatter`. The actual type of `EditableValue.formatter` is `ValueFormatter<T>`—a union that covers both built-in and plain formatters: |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.Dashes] Remove spaces around the em dash (—). Or, to set off a list item intro or number range, use an en dash (–) instead.
| It is possible for a component to extend the defined set of validation rules. A new validator—a function that checks a passed value and returns a validation message string if any—can be provided through the `setValidator` function. A component can have only a single custom validator. The Mendix Platform ensures that custom validators are run whenever necessary, for example when a page is being saved by an end-user. It is best practice to call `setValidator` early in a component's lifecycle—specifically in the [componentDidMount](https://en.reactjs.org/docs/react-component.html#componentdidmount) function. | ||
|
|
||
| In practice, many client components present values as nicely formatted strings which take locale-specific settings into account. To facilitate such cases `EditableValue` exposes a field `displayValue` formatted version of `value`, and a method `setTextValue` — a version of `setValue` that takes care of parsing. `setTextValue` also validates that a passed value can be parsed and assigns the target attribute’s type. Similarly to `setValue`, a change to an invalid value will not be propagated further that the prop itself, but a `validation` is reported. Note that if a value cannot be parsed, the prop will contain only a `displayValue` string and `value` will become undefined. | ||
| In practice, many client components present values as nicely formatted strings which take locale-specific settings into account. To facilitate such cases `EditableValue` exposes a field `displayValue` formatted version of `value`, and a method `setTextValue`—a version of `setValue` that takes care of parsing. `setTextValue` also validates that a passed value can be parsed and assigns the target attribute’s type. Similarly to `setValue`, a change to an invalid value will not be propagated further that the prop itself, but a `validation` is reported. Note that if a value cannot be parsed, the prop will contain only a `displayValue` string and `value` will become undefined. |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.Dashes] Remove spaces around the em dash (—). Or, to set off a list item intro or number range, use an en dash (–) instead.
| * **Jar** — Java libraries imported into your app using [Managed Dependencies](/refguide/managed-dependencies/), or those manually added in the **userlib** folder depending on the Studio Pro version used, such as `org.apache.commons.io`. | ||
| * **npms** — `npm` libraries that are used in your [JavaScript actions](/refguide/javascript-actions/). | ||
| * **Unknown** — When the type of the component is none of the above and hence undetermined. | ||
| * **Module** – Standard marketplace module imported from the Marketplace, such as [Community Commons](https://marketplace.mendix.com/link/component/170), or a module created by the developer. |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.Capitalization] Use ''Marketplace'' (capitalized)
| * **Jar** — Java libraries imported into your app using [Managed Dependencies](/refguide/managed-dependencies/), or those manually added in the **userlib** folder depending on the Studio Pro version used, such as `org.apache.commons.io`. | ||
| * **npms** — `npm` libraries that are used in your [JavaScript actions](/refguide/javascript-actions/). | ||
| * **Unknown** — When the type of the component is none of the above and hence undetermined. | ||
| * **Module** – Standard marketplace module imported from the Marketplace, such as [Community Commons](https://marketplace.mendix.com/link/component/170). |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.Capitalization] Use ''Marketplace'' (capitalized)
|
|
||
| * An Insights Hub user account on a **Developer** or a **Start for Free** tenant | ||
| * An Insights Hub developer role: either `mdsp:core:Developer` or `mdsp:core:DeveloperAdmin` — these are already granted on Start for Free tenants. | ||
| * An Insights Hub developer role: either `mdsp:core:Developer` or `mdsp:core:DeveloperAdmin`—these are already granted on Start for Free tenants. |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.Dashes] Remove spaces around the em dash (—). Or, to set off a list item intro or number range, use an en dash (–) instead.
| * **Jar** — Java libraries imported into your app using [Managed Dependencies](/refguide/managed-dependencies/), or those manually added in the **userlib** folder depending on the Studio Pro version used, such as `org.apache.commons.io`. | ||
| * **npms** — `npm` libraries that are used in your [JavaScript actions](/refguide/javascript-actions/). | ||
| * **Unknown** — When the type of the component is none of the above and hence undetermined. | ||
| * **Module** – Standard marketplace module imported from the Marketplace, such as [Community Commons](https://marketplace.mendix.com/link/component/170), or a module created by the developer. |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.Capitalization] Use ''Marketplace'' (capitalized)
| * **People** – Goals associated with your team. For example, you may decide that you need to train five Mendix developers within the next three months. | ||
| * **Platform** – Goals to integrate Mendix into your software development lifecycle. | ||
| * **Portfolio** – The offerings where low-code can bring high value to your organization. | ||
| * **Process** – Goals associated with your business processes. For example, you may decide to implement scrum. |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.Capitalization] Use ''Scrum'' (capitalized)
| * **In-house development** – Train and/or hire Mendix developers to develop and support all your Mendix apps. | ||
| When training in-house, we recommend choosing individuals who either have a traditional development background or have some understanding of object-oriented programming (OOP)). Beyond the technical side, Mendix recommends looking for individuals who can provide consulting to your business team. | ||
| * Mendix partner — Work with one of our certified Mendix partners to support your app development. Our directory of partners is listed [here](https://developerprofiles.mendix.com/link/partneroverview), but your Mendix team is a great resource to identify a good fit for you. | ||
| * **Mendix partner** – Work with one of our certified Mendix partners to support your app development. Our directory of partners is listed [here](https://developerprofiles.mendix.com/link/partneroverview), but your Mendix team is a great resource to identify a good fit for you. |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.LinkText] Use descriptive link text instead of '[here]('.
| Explaining the Fetch API code: | ||
|
|
||
| * The URL refers to a sample API that returns a JSON object `{ id: string, name: string }`, and `fetch` is a browser API for retrieving data which returns a promise (see the [MDI Fetch API documentation](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) — the response is a promise that is converted into data with the `.json()` function (the name is accessed and returned) | ||
| * The URL refers to a sample API that returns a JSON object `{ id: string, name: string }`, and `fetch` is a browser API for retrieving data which returns a promise (see the [MDI Fetch API documentation](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)—the response is a promise that is converted into data with the `.json()` function (the name is accessed and returned) |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.Dashes] Remove spaces around the em dash (—). Or, to set off a list item intro or number range, use an en dash (–) instead.
| Explaining the Fetch API code: | ||
|
|
||
| * The URL refers to a sample API that returns a JSON object `{ id: string, name: string }`, and `fetch` is a browser API for retrieving data which returns a promise (see the [MDI Fetch API documentation](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) — the response is a promise that is converted into data with the `.json()` function (the name is accessed and returned) | ||
| * The URL refers to a sample API that returns a JSON object `{ id: string, name: string }`, and `fetch` is a browser API for retrieving data which returns a promise (see the [MDI Fetch API documentation](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)—the response is a promise that is converted into data with the `.json()` function (the name is accessed and returned) |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.Dashes] Remove spaces around the em dash (—). Or, to set off a list item intro or number range, use an en dash (–) instead.
| Explaining the Fetch API code: | ||
|
|
||
| * The URL refers to a sample API that returns a JSON object `{ id: string, name: string }`, and `fetch` is a browser API for retrieving data which returns a promise (see the [MDI Fetch API documentation](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) — the response is a promise that is converted into data with the `.json()` function (the name is accessed and returned) | ||
| * The URL refers to a sample API that returns a JSON object `{ id: string, name: string }`, and `fetch` is a browser API for retrieving data which returns a promise (see the [MDI Fetch API documentation](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)—the response is a promise that is converted into data with the `.json()` function (the name is accessed and returned) |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.Dashes] Remove spaces around the em dash (—). Or, to set off a list item intro or number range, use an en dash (–) instead.
| * The `Label` component provided by the platform has a `for` attribute which will have a reference to the widget's ID — you must set the ID for the screen reader, so that it can link the label to the `this` input | ||
| * The `Label` component will have an ID `<widgetid>-label` — you must link the input's `aria-labelledby` to the ID of the label | ||
| * The `Label` component provided by the platform has a `for` attribute which will have a reference to the widget's ID—you must set the ID for the screen reader, so that it can link the label to the `this` input | ||
| * The `Label` component will have an ID `<widgetid>-label`—you must link the input's `aria-labelledby` to the ID of the label |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.Dashes] Remove spaces around the em dash (—). Or, to set off a list item intro or number range, use an en dash (–) instead.
|
|
||
| * Patch version — This is the third digit. This number goes up when you really have to patch a bug for a specific version and it cannot be released as part of your next major or minor version. While it is allowed to add new patch versions to older major versions, you cannot add patch versions to older minor versions within the Marketplace. | ||
| * **Major version** – This is the first digit. This number goes up when you release major breaking changes, or at the very least a major new feature, as part of your connector. Determining what is major is up to you. You can deploy minor/patch versions for older major versions when you have bugs that need resolving. | ||
| * **Minor version** – This is the second digit. This number goes up when you release minor changes that do not break backwards compatibility, and that fix some bugs, or add small new features. Depending on your development cycle, this could be intermediate releases in smaller batches. |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.AmericanSpelling] Use American English spelling 'backward' instead of 'backwards'.
| ## Introduction | ||
|
|
||
| Amazon Relational Database Service (Amazon RDS) is a collection of managed services that makes it simple to set up, operate, and scale databases in the cloud. You can choose from seven popular engines — [Amazon Aurora with MySQL compatibility](https://aws.amazon.com/rds/aurora/?pg=ln&sec=hiw), [Amazon Aurora with PostgreSQL compatibility](https://aws.amazon.com/rds/aurora/?pg=ln&sec=hiw), [MySQL](https://aws.amazon.com/rds/mysql/?pg=ln&sec=hiw), [MariaDB](https://aws.amazon.com/rds/mariadb/?pg=ln&sec=hiw), [PostgreSQL](https://aws.amazon.com/rds/postgresql/?pg=ln&sec=hiw), [Oracle](https://aws.amazon.com/rds/oracle/?pg=ln&sec=hiw), and [SQL Server](https://aws.amazon.com/rds/sqlserver/?pg=ln&sec=hiw) — and deploy on-premises with [Amazon RDS on AWS Outposts](https://aws.amazon.com/rds/outposts/?pg=ln&sec=hiw). | ||
| Amazon Relational Database Service (Amazon RDS) is a collection of managed services that makes it simple to set up, operate, and scale databases in the cloud. You can choose from seven popular engines—[Amazon Aurora with MySQL compatibility](https://aws.amazon.com/rds/aurora/?pg=ln&sec=hiw), [Amazon Aurora with PostgreSQL compatibility](https://aws.amazon.com/rds/aurora/?pg=ln&sec=hiw), [MySQL](https://aws.amazon.com/rds/mysql/?pg=ln&sec=hiw), [MariaDB](https://aws.amazon.com/rds/mariadb/?pg=ln&sec=hiw), [PostgreSQL](https://aws.amazon.com/rds/postgresql/?pg=ln&sec=hiw), [Oracle](https://aws.amazon.com/rds/oracle/?pg=ln&sec=hiw), and [SQL Server](https://aws.amazon.com/rds/sqlserver/?pg=ln&sec=hiw)—and deploy on-premises with [Amazon RDS on AWS Outposts](https://aws.amazon.com/rds/outposts/?pg=ln&sec=hiw). |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.Dashes] Remove spaces around the em dash (—). Or, to set off a list item intro or number range, use an en dash (–) instead.
|
|
||
| * **Check box** (default) — Displays a standard checkbox that reflects the current selection state. | ||
| * **Custom** — Allows you to define custom widgets for different selection states. | ||
| * **Check box** (default) – Displays a standard checkbox that reflects the current selection state. |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.CompoundWords] Use 'checkbox' instead of 'Check box'
| To deactivate Mendix SSO, follow these two steps: | ||
|
|
||
| 1. Follow the instructions below to rename the original login file (by default *login-without-sso.html*) in the **theme/web** or **theme** folder of your app to *login.html* — this removes the single sign-on button from your sign in screen: | ||
| 1. Follow the instructions below to rename the original login file (by default *login-without-sso.html*) in the **theme/web** or **theme** folder of your app to *login.html*—this removes the single sign-on button from your sign in screen: |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Mendix.Dashes] Remove spaces around the em dash (—). Or, to set off a list item intro or number range, use an en dash (–) instead.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
If you love em dashes, then I'm sorry to dash your hopes.