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.

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

Strange behaviour with devcontainer features generate-docs #876

Open
benc-uk opened this issue Aug 22, 2024 · 3 comments
Open

Strange behaviour with devcontainer features generate-docs #876

benc-uk opened this issue Aug 22, 2024 · 3 comments

Comments

@benc-uk
Copy link

benc-uk commented Aug 22, 2024

I can't get devcontainer features generate-docs to work, I've tried every combo of switches and arguments I can think of, and they don't help.

It seems to treat everything as a directory, even other files!
I'm running version 0.68.0

image

@samruddhikhandale
Copy link
Member

Hi 👋

@benc-uk Can you try running the following command 👇 ?

devcontainer features generate-docs -p src/ -n benc-uk/devc-features

-p, --project-folder Path to folder containing 'src' and 'test' sub-folders. This is likely the git root of the project.

I wonder if we should update the description and ask the user to provide the path that includes src. From reading the description, it might seem like we are asking users to add the top-level path that contains both the src and test folders.

// cc @joshspicer

@benc-uk
Copy link
Author

benc-uk commented Aug 23, 2024

Ok that worked!
I'm sure I tried that, but obviously not!

Seems like the argument description for this needs updating, it currently reports:
-p, --project-folder Path to folder containing 'src' and 'test' sub-folders. This is likely the git root of the project

EDIT: I'm happy to close this, but if you want to leave it open to track any fixes

@joshspicer
Copy link
Member

I think the behavior here should mirror the features publish command, which is:

Image

In the publish command this is a positional argument

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

No branches or pull requests

3 participants