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

Add 'heading' parameter XML docs to fix warnings during CI build #1139

Merged
merged 1 commit into from
Oct 27, 2021

Conversation

hangy
Copy link
Contributor

@hangy hangy commented Oct 27, 2021

The current CI build for the main branch has build warnings caused by a change I did previously.

Warning CS1573: Parameter 'heading' has no matching param tag in the XML comment for 'HeadingExtensions.FromAbbreviatedHeading(string, CultureInfo)' (but other parameters do)

This PR adds the missing XML documentations parameter.

Here is a checklist you should tick through before submitting a pull request:

  • Implementation is clean
  • Code adheres to the existing coding standards; e.g. no curlies for one-line blocks, no redundant empty lines between methods or code blocks, spaces rather than tabs, etc.
  • No Code Analysis warnings
  • There is proper unit test coverage
  • If the code is copied from StackOverflow (or a blog or OSS) full disclosure is included. That includes required license files and/or file headers explaining where the code came from with proper attribution
  • There are very few or no comments (because comments shouldn't be needed if you write clean code)
  • Xml documentation is added/updated for the addition/change
  • Your PR is (re)based on top of the latest commits from the main branch (more info below)
  • Link to the issue(s) you're fixing from your PR description. Use fixes #<the issue number>
  • Readme is updated if you change an existing feature or add a new one
  • Run either build.cmd or build.ps1 and ensure there are no test failures

@clairernovotny clairernovotny merged commit 77c3b53 into Humanizr:main Oct 27, 2021
@hangy hangy deleted the headings-warning branch October 27, 2021 18:29
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