LuaLS / LuaLS/lua-language-server

nodiscard for certain returned variables

Open
#3,123 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Lua
Stars
4.4k
Forks
442
PR merge metrics
No merged PRs in 30d

Description

Functions that return multiple variables may have variables that are important or not. There should be a way to flag any return value as nodiscard.

```lua
---@return number index
---@return {number:string} list
---@nodiscardall
---@return number nonimportantvariable
function getREALLYImportantList()
```
I suppose nodiscardall that marks any return above it to be important.
Maybe even `@nodiscardabove` would workout

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. Start by locating the handling for LuaDoc @return annotations and existing discard-related diagnostics, then clarify the intended scope and syntax for marking selected return values. Done means the chosen annotation behavior is implemented with coverage for functions returning multiple values.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.