refactor(Function): Rename Function to LanguageItem#2678
Merged
stanislaw merged 2 commits intostrictdoc-project:mainfrom Feb 8, 2026
Merged
refactor(Function): Rename Function to LanguageItem#2678stanislaw merged 2 commits intostrictdoc-project:mainfrom
stanislaw merged 2 commits intostrictdoc-project:mainfrom
Conversation
WHAT: Rename the class and associated variables and comments. WHY: This was triggered by strictdoc-project#2672. Rust language-aware parsing made evident we want to represent many more things that can occur in source code (enums, structs, modules, traits, expressions, type parameters, ...) - not only functions and classes. The possible list of items is long and unpredictable since it depends on supported languages which will increase over time. So it's best to represent items with a single generic class. HOW: Rename internal items only, without changing public API or functionality. For example, we keep '@relation(scope=function)' and 'RELATIONS: - FUNCTIONS: ...' for now. The generalization should be exposed to users eventually, but requires backward compatibility considerations and therefore is deferred to not block other PRs.
WHAT: Add detailed comment to LanguageItem explaining API, assumptions of use and how it supports related functionality. WHY: LanguageItem is the entry point to quite scattered functionality. A developer has to be aware of multiple related features and details that happen in distant places and stages to create the object correctly. The comment summarizes the most important (and maybe surprising) things.
stanislaw
approved these changes
Feb 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Rename the class and associated variables and comments.
Why
This was triggered by #2672. Rust language-aware parsing made evident we want to represent many more things that can occur in source code (enums, structs, modules, traits, expressions, type parameters, ...) - not only functions and classes. The possible list of items is long and unpredictable since it depends on supported languages which will increase over time. So it's best to represent items with a single generic class.
How
Rename internal items only, without changing public API or functionality. For example, we keep
@relation(scope=function)andRELATIONS: - FUNCTIONS: ...for now. The generalization should be exposed to users eventually, but requires backward compatibility considerations and therefore is deferred to not block other PRs.