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

[Docs] Use XML documentation lists #1948

Merged
merged 1 commit into from
Oct 16, 2023

Conversation

Fydar
Copy link
Contributor

@Fydar Fydar commented Oct 16, 2023

PR Details

Use proper XML documentation list syntax (<list type="bullet">) (documented here on MSDN for lists across the project.

Description

This makes the IDE experience better by properly formatting lists. Also moved some of the lists from <Summary> to <Remarks> where single-line summaries are preferred.

image

Related Issue

  • None

Motivation and Context

This makes the IDE experience better by properly formatting lists.

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My change requires a change to the documentation.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@VaclavElias
Copy link
Contributor

I like it. Looking forward to see more improvements. By the way here is a discussion on this subject, not sure if you reached it yet #1745

@Fydar
Copy link
Contributor Author

Fydar commented Oct 16, 2023

I like it. Looking forward to see more improvements. By the way here is a discussion on this subject, not sure if you reached it yet #1745

I hadn't read that yet, I hope this PR can be an example of some potential good practices we might want to adopt ❤️

@Eideren
Copy link
Collaborator

Eideren commented Oct 16, 2023

Doesn't look that great or intuitive to write, so I doubt people will adopt it that easily. Thanks anyway :)

@Eideren Eideren merged commit e017fe1 into stride3d:master Oct 16, 2023
@Fydar Fydar deleted the documentation-comments branch October 16, 2023 19:43
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.

3 participants