[Fix] Replace comment types #4785
Merged
Conversation
This file contains 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
|
Hmmm, I am not sure if the fix is correct as it most probably breaks docs formatting, right? Anyway, nested comments are not allowed, see 3rd point, section 7.1, lua 5.1 manual. But it seems we can use |
|
If we would double up those comments it would still be rendered as a comment in docs ( +-- -- Then this function will look for opts.my_map parameter and try to replace it's with |
Rspamd fails to start with Lua-5.1 because long comment does not allow nesting, see [1]. This change replaces it to short comments in order to fix the issue but preserves this part as comment in docs. [1] https://www.lua.org/manual/5.1/manual.html#7.1 Bug: https://bugs.gentoo.org/922522 Fixes: b189c9f ("[Minor] lua_maps docs: apply formatting") Fixes: rspamd#4784
arkamar
force-pushed
the
lua-maps-nested-comment
branch
from
c6947bb
to
0805aac
Compare
|
@fatalbanana good idea, thanks! I did the proposed change, plus one small typo fix. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Rspamd fails to start with lua 5-1 without this change.
Bug: https://bugs.gentoo.org/922522
Fixes: b189c9f ("[Minor] lua_maps docs: apply formatting")
Fixes: #4784