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.

Sign up for GitHub

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

Jump to bottom

Enable documentation comment validation in swift-format #165

Closed
czechboy0 opened this issue Aug 2, 2023 · 2 comments · Fixed by #188
Closed

Enable documentation comment validation in swift-format #165

czechboy0 opened this issue Aug 2, 2023 · 2 comments · Fixed by #188
Assignees
@PARAIPAN9
Labels
area/documentation Improvements or additions to documentation. kind/enhancement Improvements to existing feature. size/S Small task. (A couple of hours of work.)
Milestone
Post-1.0

Comments

@czechboy0
Copy link
Contributor

(This is about the codebase of the generator, runtime, and transports, not about generated code.)

We should enable the following two rules in the .swift-format file of all our repos, to get more validation of documentation comments. I sometimes forget to rename properties in doc comments and this could help catch that. Plus it'll ensure that new code is documented properly.

  • ValidateDocumentationComments
  • AllPublicDeclarationsHaveDocumentation
  • possibly other comments-related ones
@czechboy0 czechboy0 added area/documentation Improvements or additions to documentation. kind/enhancement Improvements to existing feature. size/S Small task. (A couple of hours of work.) labels Aug 2, 2023
@PARAIPAN9
Copy link
Contributor

Would like to take this one if it's available

@czechboy0
Copy link
Contributor Author

Yeah, go ahead!

@PARAIPAN9 PARAIPAN9 mentioned this issue Aug 10, 2023
Merged
@czechboy0 czechboy0 added this to the Post-1.0 milestone Aug 25, 2023
czechboy0 pushed a commit that referenced this issue Oct 11, 2023
@PARAIPAN9
Fixes #165 - Enable documentation comment validation in swift-format (#…
3f8542b 
…188)

### Motivation

This is for better documentation
Fixes #165

### Modifications

Enabled some rules in .swift-format

### Result

The .swift-format will be changed and the rules will reflect into the
project

### Test Plan

Run tests and CI
This was referenced Oct 17, 2023
Merged
Merged
Merged
czechboy0 pushed a commit to apple/swift-openapi-urlsession that referenced this issue Oct 23, 2023
@PARAIPAN9
Enable documentation comment validation in swift-format (#18)
aceadfd 
### Motivation

- Relates to apple/swift-openapi-generator#165

### Modifications

- Enable new rules in swift-format and address changes required

### Result

- New swift format rules will be implemented

### Test Plan

- Run the tests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@PARAIPAN9 PARAIPAN9

Labels
area/documentation Improvements or additions to documentation. kind/enhancement Improvements to existing feature. size/S Small task. (A couple of hours of work.)
Projects
None yet
Milestone
Post-1.0
2 participants
@czechboy0 @PARAIPAN9