Skip to content

Docs: Confusing "I hope to" comments in scope-manager-interface.md #19281

@JoshuaKGoldberg

Description

@JoshuaKGoldberg

Docs page(s)

https://eslint.org/docs/latest/extend/scope-manager-interface

What documentation issue do you want to solve?

The following three "> I hope to ..." lines seem like internal comments that were put on the full website?

https://eslint.org/docs/latest/extend/scope-manager-interface#set:

> I hope to rename `set` field or replace by a method.

https://eslint.org/docs/latest/extend/scope-manager-interface#functionexpressionscope:

> I hope to deprecate `functionExpressionScope` field as replacing by `scope.type === "function-expression-name"`.

https://eslint.org/docs/latest/extend/scope-manager-interface#identifiers:

> I hope to deprecate `identifiers` field as replacing by `defs[].name` field.

What do you think is the correct solution?

It seems to me that these are old comments that just have stayed on the website for a very long time. They should probably be deleted, I'd think?

Participation

  • I am willing to submit a pull request for this change.

Additional comments

Git blame points to: 1c2aafd

Metadata

Metadata

Labels

acceptedThere is consensus among the team that this change meets the criteria for inclusioncoreRelates to ESLint's core APIs and featuresdocumentationRelates to ESLint's documentation

Type

No type

Projects

Status

Complete

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions