Skip to content

📖 doc(path): improve documentation about path behaviour#1438

Open
camilamacedo86 wants to merge 1 commit into
kubernetes-sigs:mainfrom
camilamacedo86:add-doc-options
Open

📖 doc(path): improve documentation about path behaviour#1438
camilamacedo86 wants to merge 1 commit into
kubernetes-sigs:mainfrom
camilamacedo86:add-doc-options

Conversation

@camilamacedo86

@camilamacedo86 camilamacedo86 commented Jun 17, 2026

Copy link
Copy Markdown
Member

closes: #1421

@k8s-ci-robot

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: camilamacedo86
Once this PR has been reviewed and has the lgtm label, please assign alvaroaleman for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jun 17, 2026
@camilamacedo86 camilamacedo86 changed the title doc(path): improve documentation about path behaviour 📖 doc(path): improve documentation about path behaviour Jun 17, 2026
@camilamacedo86 camilamacedo86 force-pushed the add-doc-options branch 3 times, most recently from ed47eff to 2cd0cb4 Compare June 17, 2026 18:41

@nirs nirs left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Looks good, describes complicated behavior in a helpful way.

I wonder how is this rendered in the book? any preview?

Comment thread pkg/genall/options.go Outdated
// preferred brace-delimited form:
//
// paths="{./api/..., ./pkg/...}"
// paths=./api/...;./pkg/...

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Do we really want to document both ways? Isn't ; deprecated?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

It is not deprecated. Where you checked that the usage paths=./api/...;./pkg/... is deprecated?

Comment thread pkg/genall/options.go
//
// paths=./...
// paths=./api/v1
// paths=/home/user/project/api

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Using one space to indent the example is not very clear - looks like a formatting mistake instead of intentional indentation. Is this rendered in a better way?

@camilamacedo86 camilamacedo86 Jun 18, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Good catcher we should fix and do like other places.
Done.

@camilamacedo86 camilamacedo86 left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Hi @nirs

Thank you for your help here.
Could you please give a look again?

I think it is great to get merged now.
Thx

@camilamacedo86

Copy link
Copy Markdown
Member Author

Hi @nirs

Could you please give a look? Are you Ok with? If yes, could you please LGTM?

Regards

I wonder how is this rendered in the book? any preview?

That will be rendered the same way as the other docs and examples.
We don't have a preview for it here. While it looks nice, it hasn't been needed so far.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document controller-gen paths=: filesystem ./... vs import paths

3 participants