Skip to content

fix API & option descriptions #301

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

Merged
merged 5 commits into from
Apr 2, 2020
Merged

Conversation

brody4hire
Copy link
Owner

  • fix description of the mandatory name parameter in the library API
  • update --prefix & --module-prefix descriptions in README.md
  • update --prefix & --module-prefix descriptions in cli-command.js
  • update test snapshots

followup to reverted PR #278 (reverted in #299) which was in followup to PRs #276 & #264 (removing Windows C# platform support)

I think this series of updates and fixes shows the benefit of slower and more careful development.

@brody4hire brody4hire self-assigned this Apr 2, 2020
@@ -128,10 +128,10 @@ createLibraryModule({

```javascript
{
name: String, /* The name of the library (Default: Library) */
prefix: String, /* The prefix for the library (Default: ``) */
name: String, /* The name of the library (mandatory) */
Copy link
Owner Author

Choose a reason for hiding this comment

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

Suggested change
name: String, /* The name of the library (mandatory) */
name: String, /* The name of the library (Mandatory) */

@@ -128,10 +128,10 @@ createLibraryModule({

```javascript
{
name: String, /* The name of the library (Default: Library) */
prefix: String, /* The prefix for the library (Default: ``) */
name: String, /* The name of the library (mandatory) */
Copy link
Owner Author

Choose a reason for hiding this comment

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

or maybe this:

Suggested change
name: String, /* The name of the library (mandatory) */
name: String, /* The name of the library - mandatory */

@brody4hire brody4hire merged commit 2910fcb into master Apr 2, 2020
@brody4hire brody4hire deleted the fix-api-and-option-descriptions branch April 2, 2020 16:25
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.

1 participant