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

Resolve Documentation Collision for Extensions and Structs Sharing Names #6270

Merged
merged 2 commits into from May 13, 2024

Conversation

rofle100lvl
Copy link
Collaborator

@rofle100lvl rofle100lvl commented May 9, 2024

Resolves #6246

Short description πŸ“

The purpose of the pr is to make identifier of documented type accurate. Now, in some cases extensions and classes can have the same names and because of that we can see extension documentation instead of struct

How to test the changes locally 🧐

mise run docs:generate-manifests-docs
mise run docs:dev

Contributor checklist βœ…

  • [βœ…] The code has been linted using run mise run lint:fix
  • [x(Not sure about tests on web)] The change is tested via unit testing or acceptance testing, or both
  • [βœ…] The title of the PR is formulated in a way that is usable as a changelog entry
  • [βœ…] In case the PR introduces changes that affect users, the documentation has been updated

Reviewer checklist βœ…

  • The code architecture and patterns are consistent with the rest of the codebase
  • Reviewer has checked that, if needed, the PR includes the label changelog:added, changelog:fixed, or changelog:changed, and the title is usable as a changelog entry

Copy link
Member

@fortmarek fortmarek left a comment

Choose a reason for hiding this comment

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

Thanks! This makes sense to me, would wait for @pepicrft review before merging πŸ™‚

@fortmarek fortmarek requested a review from pepicrft May 13, 2024 10:46
@pepicrft
Copy link
Contributor

@all-contributors add @rofle100lvl for docs

Copy link
Contributor

@pepicrft

I've put up a pull request to add @rofle100lvl! πŸŽ‰

@pepicrft
Copy link
Contributor

Thanks a lot for this one @rofle100lvl

@pepicrft pepicrft merged commit 662e7dd into tuist:main May 13, 2024
8 checks passed
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

Successfully merging this pull request may close these issues.

Documentation of ProjectDescription extensions override the documentation of the base construct
3 participants