cli icon indicating copy to clipboard operation
cli copied to clipboard

Strange behaviour with devcontainer features generate-docs

Open benc-uk opened this issue 1 year ago • 3 comments

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

benc-uk avatar Aug 22 '24 14:08 benc-uk

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

samruddhikhandale avatar Aug 22 '24 22:08 samruddhikhandale

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

benc-uk avatar Aug 23 '24 14:08 benc-uk

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

Image

In the publish command this is a positional argument

joshspicer avatar Aug 23 '24 17:08 joshspicer