[docs] Replace use of e.g. with for example #15572
Open
+76
−76
Conversation
This file contains 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
|
I think in all cases here it'd be preferable to replace the colon with a comma. - for example:
+ for example, |
There was a problem hiding this comment.
A lot of : seemed weird to me
EDIT: I didn't see @samuelsycamore comment sorry.
I'm fine with always adding for example,
| @@ -158,7 +158,7 @@ If you are using TypeScript, please make sure to add the [theme augmentation](/x | |||
|
|
|||
| The picker components no longer have a keyboard view to render the input inside the modal on mobile. | |||
|
|
|||
| - If your date is easier to edit with the keyboard (e.g: a birthdate), you can directly use the new field components: | |||
| - If your date is easier to edit with the keyboard (for example: a birthdate), you can directly use the new field components: | |||
There was a problem hiding this comment.
Suggested change
| - If your date is easier to edit with the keyboard (for example: a birthdate), you can directly use the new field components: | |
| - If your date is easier to edit with the keyboard (for example a birthdate), you can directly use the new field components: |
| @@ -83,7 +83,7 @@ Starting with version `v8.x`, all the field and picker components come with a ne | |||
| ### Migrate `slotProps.field` | |||
|
|
|||
| When using `slotProps.field` to pass props to your field component, | |||
| the field consumes some props (e.g: `shouldRespectLeadingZeros`) and forwards the rest to the `TextField`. | |||
| the field consumes some props (for example: `shouldRespectLeadingZeros`) and forwards the rest to the `TextField`. | |||
There was a problem hiding this comment.
Suggested change
| the field consumes some props (for example: `shouldRespectLeadingZeros`) and forwards the rest to the `TextField`. | |
| the field consumes some props (for example `shouldRespectLeadingZeros`) and forwards the rest to the `TextField`. |
| @@ -407,7 +407,7 @@ If you are using a multi input range field hook, the same applies to the ref in | |||
|
|
|||
| The `useClearableField` hook API has been simplified to now take a `props` parameter instead of a `fieldProps`, `InputProps`, `clearable`, `onClear`, `slots` and `slotProps` parameters. | |||
|
|
|||
| You should now be able to directly pass the returned value from your field hook (e.g: `useDateField`) to `useClearableField` | |||
| You should now be able to directly pass the returned value from your field hook (for example: `useDateField`) to `useClearableField` | |||
There was a problem hiding this comment.
Suggested change
| You should now be able to directly pass the returned value from your field hook (for example: `useDateField`) to `useClearableField` | |
| You should now be able to directly pass the returned value from your field hook (for example `useDateField`) to `useClearableField` |
| All the props used to pass props to parts of the UI (e.g: pass a prop to the input) have been replaced by component slot props. | ||
| All the props used to override parts of the UI (e.g: pass a custom day renderer) have been replaced by component slots. | ||
| All the props used to pass props to parts of the UI (for example: pass a prop to the input) have been replaced by component slot props. | ||
| All the props used to override parts of the UI (for example: pass a custom day renderer) have been replaced by component slots. |
There was a problem hiding this comment.
Suggested change
| All the props used to override parts of the UI (for example: pass a custom day renderer) have been replaced by component slots. | |
| All the props used to override parts of the UI (for example to pass a custom day renderer) have been replaced by component slots. |
| @@ -444,8 +444,8 @@ The `locale` prop of the `LocalizationProvider` component have been renamed `ada | |||
|
|
|||
| ## Component slots / component slot props | |||
|
|
|||
| All the props used to pass props to parts of the UI (e.g: pass a prop to the input) have been replaced by component slot props. | |||
| All the props used to override parts of the UI (e.g: pass a custom day renderer) have been replaced by component slots. | |||
| All the props used to pass props to parts of the UI (for example: pass a prop to the input) have been replaced by component slot props. | |||
There was a problem hiding this comment.
Suggested change
| All the props used to pass props to parts of the UI (for example: pass a prop to the input) have been replaced by component slot props. | |
| All the props used to pass props to parts of the UI (for example to pass a prop to the input) have been replaced by component slot props. |
| @@ -132,12 +132,12 @@ export interface UsePickerValueState<TValue> { | |||
| */ | |||
| draft: TValue; | |||
| /** | |||
| * Last value published (e.g: the last value for which `shouldPublishValue` returned `true`). | |||
| * Last value published (for example: the last value for which `shouldPublishValue` returned `true`). | |||
There was a problem hiding this comment.
The one was using "e.g" instead of "i.e"
Suggested change
| * Last value published (for example: the last value for which `shouldPublishValue` returned `true`). | |
| * Last value published (the last value for which `shouldPublishValue` returned `true`). |
| * If `onChange` is defined, it's the value that was passed on the last call to this callback. | ||
| */ | ||
| lastPublishedValue: TValue; | ||
| /** | ||
| * Last value committed (e.g: the last value for which `shouldCommitValue` returned `true`). | ||
| * Last value committed (for example: the last value for which `shouldCommitValue` returned `true`). |
There was a problem hiding this comment.
Same
Suggested change
| * Last value committed (for example: the last value for which `shouldCommitValue` returned `true`). | |
| * Last value committed (the last value for which `shouldCommitValue` returned `true`). |
| @@ -266,7 +266,7 @@ export interface MuiPickersAdapter<TLocale = any> { | |||
| */ | |||
| formatNumber(numberToFormat: string): string; | |||
| /** | |||
| * Check if the two dates are equal (e.g: they represent the same timestamp). | |||
| * Check if the two dates are equal (for example: they represent the same timestamp). | |||
There was a problem hiding this comment.
Same
Suggested change
| * Check if the two dates are equal (for example: they represent the same timestamp). | |
| * Check if the two dates are equal (which means they represent the same timestamp). |
| @@ -464,7 +464,7 @@ export interface MuiPickersAdapter<TLocale = any> { | |||
| */ | |||
| getMonth(value: PickerValidDate): number; | |||
| /** | |||
| * Get the date (e.g: the day in the month) of the given date. | |||
| * Get the date (for example: the day in the month) of the given date. | |||
There was a problem hiding this comment.
Same
Suggested change
| * Get the date (for example: the day in the month) of the given date. | |
| * Get the date (day in the month) of the given date. |
| @@ -508,7 +508,7 @@ export interface MuiPickersAdapter<TLocale = any> { | |||
| */ | |||
| setMonth(value: PickerValidDate, month: number): PickerValidDate; | |||
| /** | |||
| * Set the date (e.g: the day in the month) to the given date. | |||
| * Set the date (for example: the day in the month) to the given date. | |||
There was a problem hiding this comment.
Same
Suggested change
| * Set the date (for example: the day in the month) to the given date. | |
| * Set the date (day in the month) to the given date. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Allow to smoothly upgrade docs-infra for when mui/material-ui#44513 lands.