https://github.com/dduan/DrString

DrString finds issues in your Swift docstrings and fixes them for you.
https://github.com/dduan/DrString

docstrings documentation formatter linter swift

Last synced: about 2 months ago
JSON representation

DrString finds issues in your Swift docstrings and fixes them for you.

• Host: GitHub
• URL: https://github.com/dduan/DrString
• Owner: dduan
• License: mit
• Created: 2019-09-08T05:31:05.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-02-20T23:04:09.000Z (7 months ago)
• Last Synced: 2024-07-19T03:51:42.911Z (2 months ago)
• Topics: docstrings, documentation, formatter, linter, swift
• Language: Swift
• Homepage:
• Size: 4.38 MB
• Stars: 169
• Watchers: 5
• Forks: 6
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
![Circular Logo](Documentation/Assets/Logo-Circular-Header.png)

# Dr. String in the Multiverse of Pedantry

… or "DrString", for short.

DrString helps you take control of docstrings in your Swift codebase by finding

and fixing inconsistencies among them.

![Demo](Documentation/Assets/Demo.png)

![Xcode Demo](Documentation/Assets/Demo-Xcode.png)

## Documentation

- [Getting Started][] guides you through how to use DrString in your Swift

  project.

- [Overview][] provides the _why_ s and _what_ s of docstring linting.

- [Configuration][] is a reference to all options for behavior customization.

- [Editor Integrations][] exist to improve your user experience with Xcode, and

  more!

[Getting Started]: Documentation/GettingStarted.md

[Overview]: Documentation/Overview.md

[Configuration]: Documentation/Configuration.md

[Editor Integrations]: Documentation/EditorIntegrations.md

## License

[MIT](LICENSE.md).