Skip to content

Update documentation to match expected types #260

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
May 6, 2022
Merged

Update documentation to match expected types #260

merged 3 commits into from
May 6, 2022

Conversation

@mitogh
Copy link
Member

@mitogh mitogh commented Mar 24, 2022 •
edited
Loading

Summary

This PR aims to improve the expected types and default values to improve the intellisense of the expected types to match what's used inside of each method.

Relevant technical choices

Checklist

  • PR has either [Focus] or Infrastructure label.
  • PR has a [Type] label.
  • PR has a milestone or the no milestone label.

@mitogh mitogh added Infrastructure Issues for the overall performance plugin infrastructure Miscellaneous Issues not related to an existing focus area labels Mar 24, 2022
@mitogh mitogh self-assigned this Mar 24, 2022
@mitogh mitogh removed the Infrastructure Issues for the overall performance plugin infrastructure label Mar 24, 2022
@mitogh mitogh changed the base branch from trunk to release/1.0.0-beta.4 March 24, 2022 23:55
@mitogh mitogh added the [Type] Documentation Documentation to be added or enhanced label Mar 24, 2022
@mitogh mitogh added this to the 1.0.0-beta.4 milestone Mar 24, 2022
@felixarntz felixarntz changed the base branch from release/1.0.0-beta.4 to release/1.0.0-rc.1 March 29, 2022 17:59
@felixarntz felixarntz added Infrastructure Issues for the overall performance plugin infrastructure [Focus] Images and removed Miscellaneous Issues not related to an existing focus area Infrastructure Issues for the overall performance plugin infrastructure labels Mar 29, 2022
@felixarntz
Copy link
Member

felixarntz commented Mar 29, 2022

@mitogh This is a minor detail and not affecting the production code, so I'm removing the milestone. It's okay to merge it into the release branch, but if it doesn't make it and later goes into trunk that works too. In any case, this shouldn't need to show up in changelogs, that's the main reason I'm removing the milestone.

@felixarntz felixarntz removed this from the 1.0.0-rc.1 milestone Mar 29, 2022
@felixarntz felixarntz added the no milestone PRs that do not have a defined milestone for release label Mar 29, 2022
@mitogh
Copy link
Member Author

mitogh commented Mar 29, 2022

Thanks, for the feedback @felixarntz

@felixarntz felixarntz changed the base branch from release/1.0.0-rc.1 to trunk May 6, 2022 16:51
@felixarntz felixarntz merged commit 04a16b1 into trunk May 6, 2022
@felixarntz felixarntz deleted the misc/update-dockblock branch May 6, 2022 17:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@felixarntz felixarntz felixarntz approved these changes

@mehulkaklotar mehulkaklotar mehulkaklotar approved these changes

@eugene-manuilov eugene-manuilov Awaiting requested review from eugene-manuilov

Assignees

@mitogh mitogh

Labels

no milestone PRs that do not have a defined milestone for release [Type] Documentation Documentation to be added or enhanced

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@mitogh @felixarntz @mehulkaklotar @mxbclang