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.

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

path variable renaming in Repository protocol #17

Closed
volbap opened this issue May 13, 2016 · 2 comments
Closed

path variable renaming in Repository protocol #17

volbap opened this issue May 13, 2016 · 2 comments

Comments

@volbap
Copy link
Contributor

volbap commented May 13, 2016

// Repository.swift

/// The relative path used to refer to the Repository (e.g. "users")
/// Classes conforming to `Repository` must provide this path
var path: Path { get }

path sounds confusing and is not clear here, since the actual path is what will be formed later based on this string.

E.g.

  • users is not a path, but /users is.
  • users is not a path, but /users/123 is.

name is a more appropriate name for this variable:

  • users is the name of the group of entities you are working with.
@volbap
Copy link
Contributor Author

volbap commented May 18, 2016

⚠️ Watch out for documentation updates when renaming!

@volbap
Copy link
Contributor Author

volbap commented May 26, 2016

Renaming process checklist:

  • Every appearance in code is renamed
  • Every according file is renamed
  • Project builds successfully
  • Tests pass successfully
  • There's a deprecation/migration mechanism implemented in code
  • README is updated
  • CHANGELOG is updated

volbap pushed a commit that referenced this issue May 26, 2016
volbap pushed a commit that referenced this issue May 26, 2016
volbap pushed a commit that referenced this issue May 26, 2016
@volbap volbap mentioned this issue May 26, 2016
@volbap volbap mentioned this issue May 26, 2016
@volbap volbap closed this as completed May 26, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant