Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation of VPathMatch.localPath #194

Open
saibotma opened this issue Jun 15, 2022 · 0 comments
Open

Improve documentation of VPathMatch.localPath #194

saibotma opened this issue Jun 15, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@saibotma
Copy link

saibotma commented Jun 15, 2022

I have several questions and improvements regarding the documentation of VPathMatch.localPath:

/// The local path is the one of the current VRouteElement
/// If the path has path parameters, those should be replaced
String? get localPath;

1What does “If the path has path parameters, those should be replaced” mean? I quickly debugged the variable and found out that localPath contained the path parameter (value). What is actually replaced?

From my point of view a better documentation would be:

/// The local path is the hydrated path or an hydrated alias of the current VRouteElement.
/// That means that a defined path of the form path/to/somewhere/:parameter would then look like path/to/somewhere/parameterValue
/// Local path is either a relative or an absolute path, depending on whether the corresponding path in [VPath.path] is relative or absolute.
@lulupointu lulupointu added the documentation Improvements or additions to documentation label Apr 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants