Skip to content
This repository has been archived by the owner on Jan 7, 2020. It is now read-only.

Improve class names, especially for documentation #330

Open
hunterlester opened this issue Dec 13, 2018 · 1 comment
Open

Improve class names, especially for documentation #330

hunterlester opened this issue Dec 13, 2018 · 1 comment
Assignees

Comments

@hunterlester
Copy link
Contributor

hunterlester commented Dec 13, 2018

Documentation readability could be improved by removing Interface from class names.
For example, scan your eyes down this vertical list:

AuthInterface
CipherOptInterface
CryptoInterface
ImmutableDataInterface
MutableDataInterface
WebInterface

vs.

Auth
CipherOpt
Crypto
ImmutableData
MutableData
Web

Also, I propose that MutableDataInterface becomes MutableDataContstructor to clarify what it's methods are responsible for.

Reader and Writer classes could provide clarity by being renamed to something like IDataReader and IDataWriter.

@b-zee
Copy link
Contributor

b-zee commented Dec 14, 2018

IDataReader would imply it's an interface. Interfaces shouldn't be instantiated, right? What then do the create and fetch return from ImmutableDataInterface?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants