Skip to content

Conversation

JeneaVranceanu
Copy link
Collaborator

Summary of Changes

  • Fixed Swift documentation alignment + updated it a bit in extension Web3.Personal;
  • Minor spacings update;
  • Removed some redundant comments that do not hold any value.

Test Data or Screenshots

By submitting this pull request, you are confirming the following:
  • I have reviewed the Contribution Guidelines.
  • I have performed a self-review of my own code.
  • I have updated my repository to match the develop branch.
  • I have included test data or screenshots that prove my fix is effective or that my feature works.
  • I have checked that all tests work and swiftlint is not throwing any errors/warnings.

/// print(String(data: encoded, encoding: .utf8)!)
/// //> [12,\"this\",12.2,[12.2,12.4]]`
/// ```
/// - Parameter encoder: The encoder to write data to.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This format of multiline documentation (using /// instead of /** */) is even used by Apple.
And to me personally, it looks a lot easier to edit.

Copy link
Collaborator

Choose a reason for hiding this comment

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

While i have no pref about the doc style, i have to say, that this is true only if you're staying within Xcode. All third party editor knows nothing about /// comments, and not prefix it on new line hit.

Actually because i did wrote those comments in Sublime Text i'd choose the given one doc style formatting.

@JeneaVranceanu JeneaVranceanu merged commit 58219ae into web3swift-team:develop Feb 14, 2023
@JeneaVranceanu JeneaVranceanu deleted the chore/docs-fix branch February 14, 2023 10:39
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