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

chore(docs): remove SPDX header from component docs #5810

Merged
merged 1 commit into from
Jul 17, 2024

Conversation

ShGKme
Copy link
Contributor

@ShGKme ShGKme commented Jul 16, 2024

☑️ Resolves

When there is nothing else in a mixin, styleguidist uses SPDX header as mixin's JSDoc and adds it to the component docs.

/**
 * SPDX-FileCopyrightText: 2020 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

export default {
  // Mixin

Affected components:

  • NcHeaderMenu
  • NcAppNavigationSettings
  • NcActionCheckbox
  • NcActionInput
  • NcActionLink
  • NcActionRouter
  • NcActionRadio
  • NcActionText
  • NcActionTextEditable

This can be disabled via validExtends config, but that would also remove props docs defined in mixins.

A solution - add a fake empty JSDoc in a mixin.

Alternative solution

Get rid of mixins

🖼️ Screenshots

🏚️ Before 🏡 After
image image

🏁 Checklist

  • ⛑️ Tests are included or are not applicable
  • 📘 Component documentation has been extended, updated or is not applicable
  • 3️⃣ Backport to next requested with a Vue 3 upgrade

@ShGKme ShGKme added 3. to review Waiting for reviews feature: documentation Related to the documentation labels Jul 16, 2024
@ShGKme ShGKme self-assigned this Jul 16, 2024
Copy link
Contributor

@ChristophWurst ChristophWurst left a comment

Choose a reason for hiding this comment

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

Nice

Signed-off-by: Grigorii K. Shartsev <me@shgk.me>
@ShGKme ShGKme force-pushed the chore/remove-spdx-header-from-docs branch from e80a774 to 8ea8a21 Compare July 16, 2024 19:48
@ShGKme
Copy link
Contributor Author

ShGKme commented Jul 16, 2024

Force pushed a typo fix: bellow -> below 🐮

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3. to review Waiting for reviews feature: documentation Related to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

License info in online docs
3 participants