Skip to content

docs: Add more ImplicitAllowedTypes docs#23045

Merged
CraigMacomber merged 3 commits into
microsoft:mainfrom
CraigMacomber:ImplicitAllowedTypes
Nov 9, 2024
Merged

docs: Add more ImplicitAllowedTypes docs#23045
CraigMacomber merged 3 commits into
microsoft:mainfrom
CraigMacomber:ImplicitAllowedTypes

Conversation

@CraigMacomber
Copy link
Copy Markdown
Contributor

Description

Add more ImplicitAllowedTypes docs

Reviewer Guidance

The review process is outlined on this wiki page.

@CraigMacomber CraigMacomber requested a review from a team as a code owner November 9, 2024 00:43
@github-actions github-actions Bot added area: dds Issues related to distributed data structures area: dds: tree base: main PRs targeted against main branch labels Nov 9, 2024
Comment thread packages/dds/tree/src/simple-tree/schemaTypes.ts Outdated
Comment thread packages/dds/tree/src/simple-tree/schemaTypes.ts Outdated
* class A extends sf.array("example", [() => B]) {}
* class B extends sf.array("Inner", sf.number) {}
* ```
* @public
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Do you think this should be a @System type? Even if so, I guess it's technically too late to change it...

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This type is used as an input to tons of public APIs. Making it system would be strange and make it hard to write generic functions for anything schema related without referencing it. It really seems like one of the most key types in the public schema API surface used in every place we support polymorphism. It is non system on purpose (and also to late to change if we wanted)

Comment thread packages/dds/tree/src/simple-tree/schemaTypes.ts Outdated
Copy link
Copy Markdown
Contributor

@Josmithr Josmithr left a comment

Choose a reason for hiding this comment

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

These are great! Thank you for adding them!

Co-authored-by: Noah Encke <78610362+noencke@users.noreply.github.com>
Co-authored-by: Joshua Smithrud <54606601+Josmithr@users.noreply.github.com>
@CraigMacomber CraigMacomber enabled auto-merge (squash) November 9, 2024 01:29
Copy link
Copy Markdown
Collaborator

@msfluid-bot msfluid-bot left a comment

Choose a reason for hiding this comment

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

Code Coverage Summary

↑ packages.dds.tree.src.simple-tree:
Line Coverage Change: 0.02%    Branch Coverage Change: No change
Metric NameBaseline coveragePR coverageCoverage Diff
Branch Coverage 94.07% 94.07% → No change
Line Coverage 97.21% 97.23% ↑ 0.02%

Baseline commit: 92515fa
Baseline build: 305622
Happy Coding!!

Code coverage comparison check passed!!

@msfluid-bot
Copy link
Copy Markdown
Collaborator

@fluid-example/bundle-size-tests: +245 Bytes
Metric NameBaseline SizeCompare SizeSize Diff
aqueduct.js 463.74 KB 463.77 KB +35 Bytes
azureClient.js 562.69 KB 562.74 KB +49 Bytes
connectionState.js 724 Bytes 724 Bytes No change
containerRuntime.js 261.99 KB 262 KB +14 Bytes
fluidFramework.js 426.65 KB 426.66 KB +14 Bytes
loader.js 134.18 KB 134.19 KB +14 Bytes
map.js 42.71 KB 42.71 KB +7 Bytes
matrix.js 148.32 KB 148.33 KB +7 Bytes
odspClient.js 528.43 KB 528.48 KB +49 Bytes
odspDriver.js 97.84 KB 97.86 KB +21 Bytes
odspPrefetchSnapshot.js 42.81 KB 42.83 KB +14 Bytes
sharedString.js 164.17 KB 164.17 KB +7 Bytes
sharedTree.js 417.11 KB 417.11 KB +7 Bytes
Total Size 3.36 MB 3.36 MB +245 Bytes

Baseline commit: 92515fa

Generated by 🚫 dangerJS against aee228a

@CraigMacomber CraigMacomber merged commit d1ba184 into microsoft:main Nov 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: dds: tree area: dds Issues related to distributed data structures base: main PRs targeted against main branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants