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

Allow parenthesis in examples #1960

Closed
wants to merge 3 commits into from

Conversation

mloesch
Copy link

@mloesch mloesch commented Jan 9, 2025

Describe the PR
Allow parentheses in Example and SchemaExample, e.g. Example(True feelings (maybe))

Additional context
The implementation assumes that the [Schema]Example tag will always be the last tag in a comment string.

@sdghchj
Copy link
Member

sdghchj commented Jan 13, 2025

Your PR needs the example to be at the end.
Consider a case:

@param ……            Example(True feelings (maybe))  enums(1,2,3)

True feelings (maybe)) enums(1,2,3 will be the example content.

@mloesch
Copy link
Author

mloesch commented Jan 14, 2025

I see, then I fear the solution for this problem is not trivial, as we would probably need to identify the balanced parenthesis - not sure if this is even possible with a regex - closing the PR for now.

@mloesch mloesch closed this Jan 14, 2025
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

Successfully merging this pull request may close these issues.

2 participants