Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

@see annotation is not renamed on refactor

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

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active
Tech stack
lua
Domain
tooling

Research direction

Reproduce it first: write a Lua file with a ---@class definition and a ---@see annotation pointing at that class, then try renaming the class from both the definition and the ---@see reference. The issue does not name the source files, so you will need to locate the rename handling yourself. Done means renaming the class also updates the ---@see reference, and renaming from the ---@see reference no longer returns "The Element can't be renamed".

Written by the indexing model from the issue text.

Description

How are you using the lua-language-server?

Visual Studio Code Extension (sumneko.lua)

Which OS are you using?

Linux

What is the issue affecting?

Annotations

Expected Behaviour

I'm trying to rename a class through the ---@see annotation, but I am unable to. Also renaming through the original class doesn't update the ---@see class

Actual Behaviour

It just renames the original class, without updating any of the ---@see annotations. Also get a "The Element can't be renamed"

Reproduction steps
  1. Create a ---@see annotation to a class
  2. Try to rename the class
  3. The ---@see annotation is not updated
Additional Notes

https://github.com/user-attachments/assets/df1ce125-e9ba-4480-8047-66f43400e305

As can be seen, can't rename the class through the ---@see annotation, and renaming the class doesn't update the ---@see annotation

Log File

no response

Dominant language
Lua
Stars
4.4k
Forks
452
Avg merge
15d 6h
Merged PRs (30d)
4

Getting set up

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.

More from LuaLS/lua-language-server

All issues in LuaLS/lua-language-server

Similar issues

More Lua issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.