Skip to content

Update documentation to match expected types #260

New issue

Have a question about this project? Sign up for a free account to open an issue and contact its maintainers and the community.

Sign up for

By clicking “Sign up for ”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on ? 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.

@mitoghmitogh added InfrastructureIssues for the overall performance plugin infrastructureMiscellaneousIssues not related to an existing focus arealabels Mar 24, 2022
@mitoghmitogh self-assigned this Mar 24, 2022
@mitoghmitogh removed the InfrastructureIssues for the overall performance plugin infrastructurelabel Mar 24, 2022
@mitoghmitogh changed the base branch from trunk to release/1.0.0-beta.4 March 24, 2022 23:55
@mitoghmitogh added the [Type] DocumentationDocumentation to be added or enhancedlabel Mar 24, 2022
@mitoghmitogh added this to the 1.0.0-beta.4 milestone Mar 24, 2022
@felixarntzfelixarntz changed the base branch from release/1.0.0-beta.4 to release/1.0.0-rc.1 March 29, 2022 17:59
@felixarntzfelixarntz added InfrastructureIssues for the overall performance plugin infrastructure[Focus] Images and removed MiscellaneousIssues not related to an existing focus areaInfrastructureIssues for the overall performance plugin infrastructurelabels Mar 29, 2022
@felixarntz
Copy link
Member

@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.

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

Thanks, for the feedback @felixarntz

@felixarntzfelixarntz changed the base branch from release/1.0.0-rc.1 to trunk May 6, 2022 16:51
@felixarntzfelixarntz merged commit 04a16b1 into trunk May 6, 2022
@felixarntzfelixarntz deleted the misc/update-dockblock branch May 6, 2022 17:25
Sign up for free to join this conversation on . 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 milestonePRs that do not have a defined milestone for release[Type] DocumentationDocumentation to be added or enhanced
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

4 participants
@mitogh @felixarntz @mehulkaklotar @mxbclang