Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

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

XML doc crawling should only use <para> for line breaks #3180

Closed
benmccallum opened this issue Mar 3, 2021 · 3 comments
Closed

XML doc crawling should only use <para> for line breaks #3180

benmccallum opened this issue Mar 3, 2021 · 3 comments
Labels
🐛 bug Something isn't working 🎉 enhancement New feature or request 🌶️ hot chocolate ⌛ stale Nothing happened with this issue in quite a while
Milestone

Comments

@benmccallum
Copy link
Collaborator

Describe the bug
When crawling XML comments on field members, currently the behaviour is that a line break in the XML comment --> a \n in the schema field description. This can create ugliness in UIs.

To Reproduce

        /// <summary>
        /// This is a comment that is long enough to need a new line in the
        /// CSharp but that new line shouldn't come out in description of 
        /// the field in the schema. 
        /// </summary>
        public string SomeField { get; } = "hello";

Expected behavior
New lines should only be generated for <para> usage in the XML comment.

Let GraphQL IDEs wrap long text lines themselves however they like in the available space they have.

Desktop (please complete the following information):

  • HC v11.0.9
@benmccallum benmccallum added 🐛 bug Something isn't working 🎉 enhancement New feature or request 🌶 hot chocolate labels Mar 3, 2021
@benmccallum
Copy link
Collaborator Author

This is low priority. I might one day work on it when I work on the <see> bug too.

@benmccallum
Copy link
Collaborator Author

^^ Linked above an enhancement issue this could be rolled in with

@michaelstaib michaelstaib added this to the Backlog milestone Nov 22, 2021
@stale
Copy link

stale bot commented May 4, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the ⌛ stale Nothing happened with this issue in quite a while label May 4, 2022
@stale stale bot closed this as completed May 11, 2022
@ChilliCream ChilliCream locked and limited conversation to collaborators May 11, 2022
@PascalSenn PascalSenn converted this issue into discussion #5047 May 11, 2022

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Labels
🐛 bug Something isn't working 🎉 enhancement New feature or request 🌶️ hot chocolate ⌛ stale Nothing happened with this issue in quite a while
Projects
None yet
Development

No branches or pull requests

2 participants