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

Warn user when they insert simple comments in between plumber decoration. #717

Closed
meztez opened this issue Dec 1, 2020 · 3 comments
Closed

Comments

@meztez
Copy link
Collaborator

meztez commented Dec 1, 2020

Use plumber decoration to insert comments #* or #' without any @ keyword. Simple # break the block parser.

#* Add multipart form parser
#* @parser multi
# Add rds parser
#* @parser rds
#* @param rds_file:file
#* @post /test/1
#* @png
function(rds_file) {
  plot(rds_file[[1]])
}

The block parser read from bottom to top. In this case it will start at #* @png and stop at #* @parser rds since # Add rds parser is not recognized as a Plumber decoration thus ending the block.

Annotations reference • plumber (rplumber.io)

@schloerke
Copy link
Collaborator

Should blank lines also be ignored? Similar to how roxygen2 will be greedy going upwards

@meztez
Copy link
Collaborator Author

meztez commented Dec 1, 2020

Why not, included in PR

@schloerke schloerke added this to the v1.1.0 milestone Dec 17, 2020
@schloerke
Copy link
Collaborator

Fixed in #718

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants