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

Param parsing on multiple lines #4

Closed
codefriar opened this issue Sep 21, 2020 · 5 comments
Closed

Param parsing on multiple lines #4

codefriar opened this issue Sep 21, 2020 · 5 comments
Assignees

Comments

@codefriar
Copy link

First,

Let me say GREAT work. I love this.

I've discovered an issue where it's unable to properly determine parameters when they are on multiple lines. This causes issues with the default prettier config that forces param lists to wrap to one-per-line if the overall line exceeds 80 characters.

Example code to reproduce:

    /**
     * @description - This method is where the actual work occurs. It's run once per batch.
     * @param context - dependency injected by the system
     * @param scope - a list of up to 200 SObject records to be processed
     *   in this batch. It's this mechanism of breaking a large number of records
     *   into smaller batches called scope (in this example) that make this easier
     **/
    public void execute(
        Database.BatchableContext context,
        List<Account> scope
    ) { }

This generates the following markdown:

---
## Methods
### `)` → ``

- This method is where the actual work occurs. It's run once per batch.
#### Parameters
|Param|Description|
|-----|-----------|
|`context` |  - dependency injected by the system |
|`scope` |  - a list of up to 200 SObject records to be processed |

Specifically, the issue is here:

### `)` → ``
@cesarParra
Copy link
Owner

Thanks @codefriar ! I'm looking into it.

@cesarParra cesarParra self-assigned this Sep 21, 2020
@codefriar
Copy link
Author

codefriar commented Sep 21, 2020 via email

@cesarParra
Copy link
Owner

New version (1.10.1) has been released with the fix. Thanks for bringing up the issue!

@codefriar
Copy link
Author

codefriar commented Sep 21, 2020 via email

@cesarParra
Copy link
Owner

I had not, but I definitely have to look into that!

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