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

Improving intellisense by fixing XML warnings #14663

Merged
merged 6 commits into from
Sep 6, 2023

Conversation

nikcio
Copy link
Contributor

@nikcio nikcio commented Aug 11, 2023

Prerequisites

  • I have added steps to test this contribution in the description below

Description

This fixes many of the XML warnings that are in the project. Many of the warnings broke the comment so it wasn't displayed anywhere. It was mostly legacy documentation that wasn't updated correctly and & that wasn't escaped correctly.

Note I added some white space to: src/Umbraco.Infrastructure/WebAssets/ServerVariables.js because placing the // right up against the generated XML comment in the designer file breaks the XML comment.

This shouldn't affect any of the actual code only the XML comments.

@github-actions
Copy link

github-actions bot commented Aug 11, 2023

Hi there @nikcio, thank you for this contribution! 👍

While we wait for one of the Core Collaborators team to have a look at your work, we wanted to let you know about that we have a checklist for some of the things we will consider during review:

  • It's clear what problem this is solving, there's a connected issue or a description of what the changes do and how to test them
  • The automated tests all pass (see "Checks" tab on this PR)
  • The level of security for this contribution is the same or improved
  • The level of performance for this contribution is the same or improved
  • Avoids creating breaking changes; note that behavioral changes might also be perceived as breaking
  • If this is a new feature, Umbraco HQ provided guidance on the implementation beforehand
  • 💡 The contribution looks original and the contributor is presumably allowed to share it

Don't worry if you got something wrong. We like to think of a pull request as the start of a conversation, we're happy to provide guidance on improving your contribution.

If you realize that you might want to make some changes then you can do that by adding new commits to the branch you created for this work and pushing new commits. They should then automatically show up as updates to this pull request.

Thanks, from your friendly Umbraco GitHub bot 🤖 🙂

@mikecp
Copy link
Contributor

mikecp commented Aug 12, 2023

Hi @nikcio,
Thanks for this clean-up, together with your PR #14664, it makes an impressive amount of files updates 👍
We'll handle them asap!
Cheers!

@lauraneto lauraneto self-assigned this Sep 1, 2023
@lauraneto lauraneto merged commit 6d48091 into umbraco:contrib Sep 6, 2023
13 checks passed
@lauraneto
Copy link
Contributor

Hi @nikcio ,

Thanks a lot for this pull request! So many files 🫣, but lots of good fixes!

I ended up reverting your commit docs: Fix XML in resource designer because the truth is... the generator is the one at fault here, and not the original file. Ideally we would just ignore warnings in auto-generated files, so maybe an idea for a next PR! 😁

Thanks again for the great work! 🙌

@nul800sebastiaan nul800sebastiaan changed the title docs: XML warnings Improving intellisense by fixing XML warnings Oct 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants