Skip to content

Fix that XML comment examples do not show up if the type is string and the example contains quotation marks - #2727

Merged
martincostello merged 6 commits into
domaindrivendev:masterfrom
dldl-cmd:2088_fix_string_examples_with_quotes
May 6, 2024
Merged

Fix that XML comment examples do not show up if the type is string and the example contains quotation marks#2727
martincostello merged 6 commits into
domaindrivendev:masterfrom
dldl-cmd:2088_fix_string_examples_with_quotes

Conversation

@dldl-cmd

@dldl-cmd dldl-cmd commented Oct 13, 2023

Copy link
Copy Markdown
Contributor

Fix that XML comment examples do not show up if the type is string and the example contains quotation marks

Resolves #2088

@dldl-cmd
dldl-cmd force-pushed the 2088_fix_string_examples_with_quotes branch from 618102c to 96ae699 Compare October 13, 2023 19:45
@martincostello

Copy link
Copy Markdown
Collaborator

Thanks for contributing - if you'd like to continue with this pull request, please rebase against the default branch to pick up our new CI.

@S-Tasker

S-Tasker commented Apr 15, 2024

Copy link
Copy Markdown

@dldl-cmd Does this happen to fix general issues with example parsing, such as backslashes in the string leading to the example being omitted completely?
EDIT: Nevermind, saw the example post, it clearly does.

@dldl-cmd
dldl-cmd force-pushed the 2088_fix_string_examples_with_quotes branch from 33ae493 to 3ca86f8 Compare April 15, 2024 18:34
@S-Tasker

Copy link
Copy Markdown

@martincostello It looks like the expected CI builds didn't run here - they're awaiting approval.

@codecov-commenter

codecov-commenter commented Apr 19, 2024

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.39%. Comparing base (42e6876) to head (7989435).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2727      +/-   ##
==========================================
- Coverage   92.40%   92.39%   -0.02%     
==========================================
  Files          93       94       +1     
  Lines        3174     3167       -7     
  Branches      558      555       -3     
==========================================
- Hits         2933     2926       -7     
  Misses        241      241              
Flag Coverage Δ
Linux 92.39% <100.00%> (-0.02%) ⬇️
Windows 92.39% <100.00%> (+2.28%) ⬆️
macOS 92.39% <100.00%> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Comment thread src/Swashbuckle.AspNetCore.SwaggerGen/XmlComments/XmlCommentsExampleHelper.cs Outdated
Comment thread src/Swashbuckle.AspNetCore.SwaggerGen/XmlComments/XmlCommentsExampleHelper.cs Outdated
@dldl-cmd
dldl-cmd requested a review from martincostello May 5, 2024 14:13
@dldl-cmd
dldl-cmd force-pushed the 2088_fix_string_examples_with_quotes branch from dbaecbc to 7989435 Compare May 5, 2024 14:49
@S-Tasker

S-Tasker commented May 6, 2024

Copy link
Copy Markdown

Is this something that mind find its way into v6.6 by any chance?

This was referenced Jul 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet