-
Notifications
You must be signed in to change notification settings - Fork 8
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
Invalid auto-generated markdown for procedure parameters wrapped in double-quotes #399
Comments
Hi again @vody, and thanks for reporting this. That being said, I understand that there are old code that you might not be able to change. At least not right now. I'm not sure that I agree with your suggestion. If it is named with double quotes, why not output that with double quotes? Leaving them out of the anchor name, since otherwise it is invalid.
If this should be fixed, scenarios as below should be handled as well.
it should result in something like this, right?
What do you say about that? |
@jwikman, an issue has been raised as we have a valid AL code and an invalid markdown one. :) |
@jwikman, if we would like to bring this change in, then we may need to apply the same logic for returns. |
@vody I added some comments in the PR :) I'm fine with removing the " from the output in docs, but when we're at it, we should probably support valid names with double double-quotes inside the names as well. Don't you agree? |
@jwikman, agree. I will try to find some time to redo a PR. |
@vody Just reach out to me or @theschitz if you need any help (or if you just can't find the time for this). However, the time zone difference may cause some response delay... 😁 |
Describe the bug
With procedure parameters wrapped in double quotes as in the example below extension generates an invalid markdown.
Code Example:
Autogenerated Markdown:
Versions used
Version: 1.68.1 (user setup)
Commit: 30d9c6cd9483b2cc586687151bcbcd635f373630
Date: 2022-06-14T12:48:58.283Z
Electron: 17.4.7
Chromium: 98.0.4758.141
Node.js: 16.13.0
V8: 9.8.177.13-electron.0
OS: Windows_NT x64 10.0.19044
NAB AL Tools: v1.27.207070852
To Reproduce
Steps to reproduce the behavior:
NAB: Generate External Documentation
commandExpected behavior
Double-quotes should be removed before the parameter name is used to generate markdown content. Example:
The text was updated successfully, but these errors were encountered: