From 27872f0c7e2af0871b27188725407c0c4d84557e Mon Sep 17 00:00:00 2001 From: ffrostfall <80861876+ffrostfall@users.noreply.github.com> Date: Wed, 23 Apr 2025 22:01:43 -0400 Subject: [PATCH] Write Design + Drawbacks --- docs/luaurc-definition-files.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/luaurc-definition-files.md b/docs/luaurc-definition-files.md index 136a45d..93f447a 100644 --- a/docs/luaurc-definition-files.md +++ b/docs/luaurc-definition-files.md @@ -10,12 +10,12 @@ As cross-runtime code becomes increasingly common, the model which language serv ## Design -This is the bulk of the proposal. Explain the design in enough detail for somebody familiar with the language to understand, and include examples of how the feature is used. +When analyzing a file, include all of the files specified in the `declarationFiles` field in analyzation. This supercedes the `globals` field, which should be deprecated. ## Drawbacks -This brings declaration files to be in a much more user-facing spot, when definition files are not meant to be user-facing. +This brings declaration files to be in a much more user-facing spot, when definition files are not meant to be user-facing. This could cause confusion, as definition files are currently largely undocumented and have poor syntax. ## Alternatives -What other designs have been considered? What is the impact of not doing this? +TODO