Skip to content

docs: fix 12 typos in READMEs and changelog #624

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.

Sign up for GitHub

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

Open
Avicennasis wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix 12 typos in READMEs and changelog #624

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ Note: this applies to NMR for latest Studio Pro (currently 9.X)
- Ensure your current git branch includes all changes intended to be released.
- Including updates to widgets' changelogs and semver version in `package.json` and `package.xml`.
- Build all widgets in release mode; in root of repo run `pnpm release`.
- Copy each widgets' `.mpk` to the NMR project's `/widgets` directory, overriding any existing `.mpk`s.
- (conditional) If the widget is new, it needs to be listed on the NMR project page `NativeModileResources._WidgetExport`.
- Copy each widget's `.mpk` to the NMR project's `/widgets` directory, overriding any existing `.mpk`s.
- (conditional) If the widget is new, it needs to be listed on the NMR project page `NativeMobileResources._WidgetExport`.
- Configure the widget with basic minimum requirements (e.g. datasource), enough to avoid any project errors.
- Ensure monorepo's `mobile-resources-native` package has correct changelog and `package.json` version.
- cd to `packages/jsActions/mobile-resources-native` and run `pnpm release`.
Expand Down
4 changes: 2 additions & 2 deletions packages/jsActions/nanoflow-actions-native/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ To enable it you can set the new SignIn action parameter `useAuthToken` to `true
- Base64DecodeToImage
- Base64Encode
- GetStraightLineDistance
- New "Enum_DistanceUnit" enum is introduce for GetStraightLineDistance action
- New "Enum_DistanceUnit" enum is introduced for GetStraightLineDistance action

## [2.5.0] Nanoflow Commons - 2022-7-25

Expand Down Expand Up @@ -153,7 +153,7 @@ To enable it you can set the new SignIn action parameter `useAuthToken` to `true
### Added

- We introduced a new [Clear cached session data] action to clear the cached session data from local storage.
- We introdcued a new [Reload] action that reloads the app.
- We introduced a new [Reload] action that reloads the app.

### Breaking

Expand Down
12 changes: 6 additions & 6 deletions packages/pluggableWidgets/bottom-sheet-native/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,12 @@ A main object has four objects. Objects with **?** are optional and do not need

#### ModalItemsStyle

| Style Key | Description |
| ------------------------------ | ----------------------------------------------------------- |
| defaultStyle?: BasicItemStyle; | Styles all basic items which has "default" style selected\. |
| primaryStyle?: BasicItemStyle; | Styles all basic items which has "primary" style selected\. |
| dangerStyle?: BasicItemStyle; | Styles all basic items which has "danger" style selected\. |
| customStyle?: BasicItemStyle; | Styles all basic items which has "custom" style selected\. |
| Style Key | Description |
| ------------------------------ | ------------------------------------------------------------ |
| defaultStyle?: BasicItemStyle; | Styles all basic items which have "default" style selected\. |
| primaryStyle?: BasicItemStyle; | Styles all basic items which have "primary" style selected\. |
| dangerStyle?: BasicItemStyle; | Styles all basic items which have "danger" style selected\. |
| customStyle?: BasicItemStyle; | Styles all basic items which have "custom" style selected\. |

Example:

Expand Down
14 changes: 7 additions & 7 deletions packages/pluggableWidgets/carousel-native/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ export myCarouselStyle = {

#### Pagination

| Style Key | Description |
| --------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| container: ViewStyle | Styles the main view around pagination, regardless of text or dot. |
| dotStyle: ViewStyle + color?: string | Styles all the pagination dots. |
| inactiveDotStyle: ViewStyle + {opacity?: number; scale?: number; color?: string}; | Additional styles for inactive dots. Will be merged with dotStyle. |
| dotContainerStyle: ViewStyle | Styles the view around individual pagination dots |
| text: TextStyle | Will be applied when there is more than 5 elements in carousel and pagination buttons becomes text like "1/5". |
| Style Key | Description |
| --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| container: ViewStyle | Styles the main view around pagination, regardless of text or dot. |
| dotStyle: ViewStyle + color?: string | Styles all the pagination dots. |
| inactiveDotStyle: ViewStyle + {opacity?: number; scale?: number; color?: string}; | Additional styles for inactive dots. Will be merged with dotStyle. |
| dotContainerStyle: ViewStyle | Styles the view around individual pagination dots |
| text: TextStyle | Will be applied when there is more than 5 elements in carousel and pagination buttons become text like "1/5". |
4 changes: 2 additions & 2 deletions packages/pluggableWidgets/gallery-native/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Defines the amount of data shown for each page or the limit to be presented.

### 2.3.2 Pagination

You can choose between `Load more button` (button being presented below) or `Virtual scrolling` (mechanism that automatically loads data when the users reaches the bottom of the scrollbar).
You can choose between `Load more button` (button being presented below) or `Virtual scrolling` (mechanism that automatically loads data when the user reaches the bottom of the scrollbar).

### 2.3.3 Empty Message

Expand All @@ -51,7 +51,7 @@ Triggers an action (such as a nanoflow, Show page, etc. action) when the end-use

### 2.4.2 On Pull Down Action

Triggers an action (such as a nanoflow, Synchronize, etc. action) when the end-user swipe down of the list.
Triggers an action (such as a nanoflow, Synchronize, etc. action) when the end-user swipes down on the list.

### Filtering

Expand Down
2 changes: 1 addition & 1 deletion scripts/release/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

- JS actions in `nanoflow-actions-native` are included in and released with Nanoflow Commons.

1. Make sure each changed widget has an appropriate change to it's `package.json` & `package.xml` (version bump) and changelog update before releasing.
1. Make sure each changed widget has an appropriate change to its `package.json` & `package.xml` (version bump) and changelog update before releasing.
1. In `CHANGELOG.md`, try to avoid using special characters like backtick[`] around the text while updating the changelog because it won't be able to parse the text; instead you can use square brackets[].
1. Each widget (e.g. `bar-chart-native`) or module's (e.g. `mobile-resources-native`) `minimumMXVersion` in `package.json` should match the `NativeComponentsTestProject` Mendix project Studio Pro version. You can pull the [repo](https://github.com/mendix/Native-Mobile-Resources) into Windows and double-click the `.mpr` in the root. You should have at least one Studio Pro installation for this to work.
1. On `master`, once all to-be-released changes are merged, add a tag to the commit you want to create a release from. The tag should
Expand Down