Skip to content
This repository has been archived by the owner on Nov 27, 2023. It is now read-only.

Tweak and reorder YARD documentation #18

Merged
merged 10 commits into from
Jan 14, 2020
Merged

Conversation

epistrephein
Copy link
Owner

@epistrephein epistrephein commented Jan 11, 2020

Pull Request description

  • Rename attr_reader conn to connection
  • Fix token_time and last_request class being Float and not Integer
  • Put examples after descriptions, to mirror how yard renders the blocks and improve readability
  • Remove redundant 'return' and 'exception raised' in @return and @raise blocks
  • Add extended descriptions to all attr_readers
  • Put 'Accepted values' and 'Default' in their own line
  • Link module constants and methods with YARD markup
  • Add a note linking to Faraday documentation
  • Reorder attr_readers

Pull Request checklist

Kind of change
  • My code is a minor change (typos, configuration, anything not related to core functionality)
  • My code is a bug fix (non-breaking change which fixes an issue)
  • My code is a new feature (non-breaking change which adds functionality)
  • My code introduces a breaking change (fix or feature that would break existing functionality)
Style and tests
  • My code follows the code style of this project
  • I have added tests to cover my changes
  • All new and existing tests passed
Documentation
  • My change requires a change to the documentation
  • I have updated the documentation accordingly
Changelog
  • I have included the CHANGELOG entry for the changes

- Fix token_time and last_request class being Float and not Integer
- Put examples after descriptions, to mirror how yard renders the blocks
and improve readability
- Remove redundant 'return' and 'exception raised' in @return and @raise
blocks
- Add extended descriptions to all attr_readers
- Put 'Accepted values' and 'Default' in their own line
@epistrephein epistrephein self-assigned this Jan 11, 2020
@epistrephein epistrephein added the docs Improvements or additions to documentation label Jan 11, 2020
@epistrephein epistrephein added this to the v2.0 milestone Jan 11, 2020
@epistrephein epistrephein changed the title Tweak and reoder documentation Tweak and reoder YARD documentation Jan 11, 2020
@epistrephein epistrephein changed the title Tweak and reoder YARD documentation Tweak and reorder YARD documentation Jan 12, 2020
@epistrephein epistrephein merged commit 1b9bdd0 into master Jan 14, 2020
@epistrephein epistrephein deleted the documentation-tweaks branch January 14, 2020 06:13
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant