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

Instructions are invalid for the current version of vlib/v/README.md #23702

Open
quaesitor-scientiam opened this issue Feb 12, 2025 · 2 comments
Labels
Unit: Documentation Bugs/feature requests, that are related to the documentations.

Comments

@quaesitor-scientiam
Copy link
Contributor

quaesitor-scientiam commented Feb 12, 2025

Describe the issue

Lines 49-56 speak of creating a Scope reference. Yet it cannot be used in the methods the current document says it can. This begs the question why exists and how it is supposed to be used.

Lines 69 - 78 uses the v.parser to parse a file. The parse_file() function no longer takes the Scope parameter so the documentation is wrong in detailing that. Current code definition: pub fn parse_file(path string, mut table ast.Table, comments_mode scanner.CommentsMode, pref_ &pref.Preferences) &ast.File.

Lines 59 - 67 has the same issue as single file in not supporting the Scope reference as parameter. Current code definition: pub fn parse_text(text string, path string, mut table ast.Table, comments_mode scanner.CommentsMode, pref_ &pref.Preferences) &ast.File {

Lines 80 - 89 also has the same issue as single file in not supporting the Scope reference as parameter. Current code definition: pub fn parse_files(paths []string, mut table ast.Table, pref_ &pref.Preferences) []&ast.File {

Links

https://github.com/vlang/v/blob/eecaa64e9d82ea81ee2dcd8d4234440da7293400/vlib/v/README.md

Note

You can use the 👍 reaction to increase the issue's priority for developers.

Please note that only the 👍 reaction to the issue itself counts as a vote.
Other reactions and those to comments will not be taken into account.

@quaesitor-scientiam quaesitor-scientiam added the Unit: Documentation Bugs/feature requests, that are related to the documentations. label Feb 12, 2025
Copy link

Connected to Huly®: V_0.6-22122

@quaesitor-scientiam quaesitor-scientiam changed the title Instruction are invalid the current release of V Instructions are invalid for the current release of V Readme doc Feb 12, 2025
@quaesitor-scientiam
Copy link
Contributor Author

I would update the documentation but don't have the understanding to explain why Scope was removed. In tracing the code I did discover the Scope is auto-generated later in the code.

@spytheman spytheman changed the title Instructions are invalid for the current release of V Readme doc Instructions are invalid for the current version of vlib/v/README.md Feb 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Unit: Documentation Bugs/feature requests, that are related to the documentations.
Projects
None yet
Development

No branches or pull requests

1 participant