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.

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

Jump to bottom

Bad Documenation with errors #1330

Closed
1 of 3 tasks
b1tw0rker opened this issue Dec 27, 2024 · 1 comment · Fixed by #1325
Closed
1 of 3 tasks

Bad Documenation with errors #1330

b1tw0rker opened this issue Dec 27, 2024 · 1 comment · Fixed by #1325

Comments

@b1tw0rker
Copy link

b1tw0rker commented Dec 27, 2024 •
edited by ayushmanchhabra
Loading

Issue Type

  • Bug Report
  • Feature Request
  • Other

Current/Missing Behaviour

Expected/Proposed Behaviour

Additional Info

  • Package version: latest
  • Operating System: win
  • Node version: 22 LTS
  • NW.js version: latest
  • Repro link:

Bad documentation which is not understandable for newbies. srcDir is in the docu bute running it in nwbuild throws unknown option '--srcDir=./' -

console error output: "error: missing required argument 'string'" - what the heck is this ?
@ayushmanchhabra
Copy link
Collaborator

When using CLI, we don't use srcDir option.

Bad usage:

nwbuild --srcDir=/path/to/app

Good usage

nwbuild /path/to/app

If this is due to unclear documentation, please give suggestions on how to improve it.

ayushmanchhabra added a commit that referenced this issue Jan 1, 2025
@ayushmanchhabra
chore(docs): clarify non-usage of srcDir in CLi interface
1b61bd1 
Refs: #1330
@github-actions github-actions bot mentioned this issue Jan 1, 2025
Merged
ayushmanchhabra pushed a commit that referenced this issue Jan 1, 2025
@github-actions
chore(main): release 4.13.8 (#1325)
ce71ec8 
🤖 I have created a release *beep* *boop*
---


##
[4.13.8](v4.13.7...v4.13.8)
(2025-01-01)


### Bug Fixes

* **bld:** await archiver.finalize
([#1333](#1333))
([580668f](580668f)),
closes [#1328](#1328)


### Chores

* **deps:** bump the npm group across 1 directory with 11 updates
([#1332](#1332))
([b9b96ff](b9b96ff))
* **docs:** clarify CJS usage
([d673459](d673459)),
closes [#1331](#1331)
* **docs:** clarify non-usage of srcDir in CLi interface
([1b61bd1](1b61bd1)),
closes [#1330](#1330)
* **docs:** fix CJS import usage example
([5f323df](5f323df)),
closes [#1331](#1331)
* **test:** download latest NW.js version for Linux demo app
([8c09908](8c09908)),
closes [#1324](#1324)

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore(main): release 4.13.8 nwutils/nw-builder
2 participants
@ayushmanchhabra @b1tw0rker