Skip to content

[Swift] Add documentation to input structs' init#1619

Merged
designatednerd merged 1 commit intoapollographql:masterfrom
kevinmbeaulieu:kb/document-input-init
Dec 18, 2019
Merged

[Swift] Add documentation to input structs' init#1619
designatednerd merged 1 commit intoapollographql:masterfrom
kevinmbeaulieu:kb/document-input-init

Conversation

@kevinmbeaulieu
Copy link
Copy Markdown
Contributor

@kevinmbeaulieu kevinmbeaulieu commented Oct 26, 2019

Implement feature request to add documentation to input structs' generated constructors.

Generates documentation of the form:

/// - Parameters:
///   - someUndocumentedField
///   - someDocumentedField: This field has a documentation comment. When it is really long,
/// it wraps like this.

The way the text wraps is admittedly not ideal, but I couldn't think of a good way to make it wrap like this:

///   - someDocumentedField: This field has a documentation comment. When it is really long,
///                          it would be nice if it wrapped like this.

TODO:

  • Update CHANGELOG.md* with your change (include reference to issue & this PR)
  • Make sure all of the significant new logic is covered by tests
  • Rebase your changes on master so that they can be merged easily
  • Make sure all tests and linter rules pass

@zionts
Copy link
Copy Markdown
Contributor

zionts commented Dec 18, 2019

@designatednerd you might be the right person to take a look here :)

Copy link
Copy Markdown
Contributor

@designatednerd designatednerd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ooh neat! Sorry I missed this when it was submitted!

@kevinmbeaulieu
Copy link
Copy Markdown
Contributor Author

No prob, thanks! Just rebased so should be safe for someone to merge once CI finishes re-running

@designatednerd designatednerd merged commit 3873bb3 into apollographql:master Dec 18, 2019
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.

3 participants