summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2023-07-19make 3rds最萌小汐
2023-05-16Merge pull request #2111 from fesily/meta-fix-jit-module最萌小汐
meta:fix jit module
2023-05-15move other filefesily
2023-05-11Annotation rule for exported local functionsThomas Wetzlmaier
Annotation for the following local function func1 is required. local mod = { } local function func1() end mod.Func1 = func1 return mod;
2023-04-24Cleanup PRAndreaWalchshoferSCCH
Revert Changes made from unrelated PR
2023-04-19Warn about missing '---comment', '@return' and '@param' annotations (#3)Thomas Wetzlmaier
All functions that have at least one such annotation should be fully annotated in that respect, because we find that partially annotating something leads to confusion. However, all global functions must always be fully annotated, because they should be avoided in the first place, but if necessary then only with the maximum amount of documentation/support for those who use them! We provide the following keys for the `diagnostics.disable` setting to specifically deactive these checks: _missing-global-doc_: global function definitions which are not fully annotated. _incomplete-signature-doc_: function definitions that have some annotations but are not fully annotated
2023-04-04Add diagnostic to enforce lowercase local element names (#6)AndreaWalchshoferSCCH
- diagnostic `uppercase-local` in group `conventions`, disabled by default - isolated unit tests for diagnostic
2023-03-30Incorporate Review Comments (#4)AndreaWalchshoferSCCH
* add newlines to end of files * change the group name to `conventions`
2023-03-30Revert "Add diagnostic to enforce lowercase local element names (#2)" (#5)AndreaWalchshoferSCCH
This reverts commit 43794193ef981ffecb477bfce444428ded852aa0.
2023-03-30Add diagnostic to enforce lowercase local element names (#2)AndreaWalchshoferSCCH
2023-03-22Add diagnostic warning about any global (#1)AndreaWalchshoferSCCH
* Add warning for any global variable via diagnostic * Add messages in en-US TODO: add messages in languages other than en-us as well * fallback: enable/disable diagnostics w/ annotation * Add tests for the new diagnostic * Add diagnostic and group to config.md
2023-02-15fix empty object最萌小汐
2023-02-03chore: update links to point to organizationcarsakiller
2023-01-30update submodules and docs最萌小汐
2023-01-16remove telemetry最萌小汐
2022-12-06Added descriptions for the invisible diagnostics and the typeFormat ↵Martin Armbruster
configuration.
2022-08-12Added missing descriptions for diagnostics.Martin Armbruster
2022-08-01update docs最萌小汐
2022-07-27fix: wiki link referencescarsakiller
2022-07-23Plugin enchancementsNicholas Dunn
Adds config.runtime.plugingArgs Adds pluginPath to package.path. Closes #1297 Adds log.warn() when specified plugin can't be found Possible Changelog entry: ```txt * `NEW` `Lua.runtime.pluginArgs` * `CHG` add plugin path in package.path ```
2022-07-12sort enums最萌小汐
2022-07-12unreachable-code最萌小汐
2022-07-07resolve #619 `diagnostics.unusedLocalExclude`最萌小汐
2022-07-06completion and diags for operator最萌小汐
2022-07-05resolve #1254 can suppress syntax errors最萌小汐
2022-07-05#1254 more non-standard symbols最萌小汐
2022-07-01#1260 `type.weakNilCheck`最萌小汐
2022-06-29update `config.md`最萌小汐
2022-06-29繁體中文翻譯AlexCai2019
1. 翻譯 `zh_tw/script.lua` 內 `DIAG_DUPLICATE_DOC_ALIAS`, `DIAG_MISSING_RETURN_VALUE`, `DIAG_MISSING_RETURN_VALUE_RANGE`, `DIAG_REDUNDANT_RETURN_VALUE`, `DIAG_REDUNDANT_RETURN_VALUE_RANGE`, `DIAG_MISSING_RETURN`, `DIAG_RETURN_TYPE_MISMATCH`, `LUADOC_DESC_CAST`。 2. 翻譯 `zh_tw/settings.lua` 內 `config.hint.semicolon`, `config.hint.semicolon.All`, `config.hint.semicolon.SameLine`, `config.hint.semicolon.Disable`, `config.type.castNumberToInteger`, `config.type.weakUnionCheck`。 3. "deprecated" 從「廢棄」改成「棄用」,因為後者的翻譯比較常見,同時也是維基百科所採用的翻譯。
2022-06-25update doc最萌小汐
2022-06-25make doc with description of groups最萌小汐
2022-06-25繁體中文翻譯AlexCai2019
1. 翻譯 `zh_tw/script.lua` 內 `DIAG_CAST_LOCAL_TYPE`, `DIAG_CAST_FIELD_TYPE`, `DIAG_ASSIGN_TYPE_MISMATCH`, `DIAG_PARAM_TYPE_MISMATCH`, `DIAG_UNKNOWN_CAST_VARIABLE`, `DIAG_CAST_TYPE_MISMATCH`, `ACTION_ADD_DICT`, `COMMAND_ADD_DICT`, `LUADOC_DESC_CLASS`, `LUADOC_DESC_TYPE`, `LUADOC_DESC_ALIAS`, `LUADOC_DESC_PARAM`, `LUADOC_DESC_RETURN` `LUADOC_DESC_FIELD`, `LUADOC_DESC_GENERIC`, `LUADOC_DESC_VARARG`, `LUADOC_DESC_OVERLOAD`, `LUADOC_DESC_DEPRECATED`, `LUADOC_DESC_META`, `LUADOC_DESC_VERSION`, `LUADOC_DESC_SEE`, `LUADOC_DESC_DIAGNOSTIC`, `LUADOC_DESC_MODULE`, `LUADOC_DESC_ASYNC`, `LUADOC_DESC_NODISCARD`, `LUADOC_DESC_CAST`。 2. 翻譯 `zh_tw/settings.lua` 內 `config.runtime.meta`, `config.diagnostics.severity`, `config.diagnostics.neededFileStatus`, `config.diagnostics.groupSeverity`, `config.diagnostics.groupFileStatus`, `config.hover.expandAlias`, `config.hint.await`, `config.format.defaultConfig`, `config.spell.dict`。 3. `zh_tw/meta.lua` 內 `tonumber` 轉換失敗時的回傳值修正為 `fail` ,與 `en-us/meta.lua` 的描述一致。 4. `zh_tw/meta.lua` 內 `tostring` 有關$string.format的資訊放到最後一行。 5. `zh_tw/meta.lua` 內 `os.clock` 的描述改為 '回傳程式使用的 CPU 時間的近似值,單位為秒。',我個人認為這樣更為通順。 6. `zh_tw/setting.lua` 內 `config.diagnostics.workspaceRate` 的描述改為 "...百分比)。降低該值會減少CPU使用率,但是也...",也是為了通順。 7. 「閲」改成「閱」。 根據教育部《國語辭典簡編本》,「閱」是正字,而「閲」是異體字。 8. "process" 從「程序」改成「處理程序」,因為Windows工作管理員(Task Manager)是這樣翻譯的。 9. "data type" 從「型別」改成「類型」,因為Visual Studio C/C++是這樣翻譯的。 10. "metatable" 從「元表」改成「中繼資料表」,因 "metadata" 在微軟文件(Microsoft Docs)、Adobe官網和Canva說明中心內均被譯為「中繼資料」,取其 "meta" 為「中繼」之意。 11. "hook" 從「鉤子」改成「攔截」,因微軟文件將 "hook function" 譯為「攔截函式」。 12. "language server" 從 「語言服務」改成「語言伺服」,因為 "server" 一詞在繁體中文本來就是「伺服器」。 13. `script.lua` 內 `LUADOC_DESC_FIELD` 拼錯 "Declare" (拼成"Decalare"),已修正所有語言的檔案。 14. `script.lua` 內 `LUADOC_DESC_MODULE` 拼錯 "require" (拼成"reqire"),已修正所有語言的檔案。 15. 其他瑣碎的更改。
2022-06-24update doc最萌小汐
2022-06-23update config最萌小汐
2022-06-23build doc最萌小汐
2022-06-09add locale最萌小汐
2022-06-09update doc最萌小汐
2022-06-09rename doc最萌小汐
2022-06-09update doc最萌小汐
2022-06-09update config最萌小汐
2022-06-08config doc最萌小汐