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

[Documentation] Documentation bug on vuetify3 data table header examples #20725

Open
constantijn opened this issue Nov 22, 2024 · 1 comment
Open
Labels
good first issue A quick-win fix that would be great for new contributors S: needs docs update The change requires an update to the documentation T: documentation

Comments

@constantijn
Copy link

Environment

Vuetify Version: 3.7.4
Vue Version: 3.5.13
Browsers: Chrome 131.0.0.0
OS: Mac OS 10.15.7

Steps to reproduce

Hi, I found a documentation bug:

https://vuetifyjs.com/en/api/v-data-table/#props-headers

Says:
An array of objects that each describe a header column. See the example below for a definition of all properties.

But unless ctrl-f is failing me i can't find that example?

https://vuetifyjs.com/en/api/v-data-table/#slots-headers is the closest thing but it's not very helpful.

Expected Behavior

The example referenced in the doc exists

Actual Behavior

The example referenced in the doc doesn't exist.

Reproduction Link

https://vuetifyjs.com/en/api/v-data-table/#props-headers

@MatthewAry MatthewAry added S: needs docs update The change requires an update to the documentation good first issue A quick-win fix that would be great for new contributors T: documentation labels Nov 26, 2024
@MatthewAry
Copy link
Contributor

Your reproduction link is to the API page, which as you pointed out makes reference to something that is not there. I personally think the current structure for VDataTable documentation needs some revision. You are free to make a PR to update the following parts which make up the VDataTable docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue A quick-win fix that would be great for new contributors S: needs docs update The change requires an update to the documentation T: documentation
Projects
None yet
Development

No branches or pull requests

2 participants