-
Notifications
You must be signed in to change notification settings - Fork 0
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
Cleanup source code prior to release #171
Conversation
3e8bc18
to
36a79a2
Compare
36a79a2
to
ea251c3
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks good, I only found some typos, but you can fix them in a follow-up PR.
DataCapturing/README.md
Outdated
You can implement your own data storage if you like by reacting to the messages sent from a running `Measurement` and storing the captured data however you like. | ||
|
||
For convenience, the Cyface SDK provides its own data storage layer, which is designed to receive sensor data from a `Measurement` and store it to a permanent storage area. | ||
The default implmentations provided with the SDK uses Apples *CoreData* framework. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just a type: implementations .... use(not uses)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
actually it is "implementation ... uses"
DataCapturing/README.md
Outdated
|
||
* **Measurement:** Represent a single measurement in the database. It has two attributes `synchronizable` and `synchronized`, tracking if it is possible and necessary to synchronize this measurement with a storage server. Each measurement also gets a device wide unique `identifier`, which is implemented as a counter. | ||
* **Track:** A measurement contains one or more tracks. A track is created when the measurement is resumed after a pause. | ||
* **Event:** This tracks user interactions like putton presses to manipulate an active measurement. Start, stop, pause and resume events are recorded as this entity as well as modality changes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo: button.... events are recorded as this entity? (did you mean as "an" entity?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No. Since this is an Entity-Relationship-Diagram all the boxes are called "Entity" and thus "Event" is an "Entity" and the four events "Start", "Stop", "Pause" and "Resume" are recorded as an "Event-Entity", so they are recorded as this (the explained one) Entity.
Cleanup source code prior to release
Many of those over 1.000 changed files are just deleted old generated documentation files. Maybe concentrate on the *.swift files and maybe even more important the updated README.md.
... and just ignore the fact, that this does not build. I've created a new task for that issue and as I told you also created a StackOverflow-Question about this. It works with XCode, just not using terminal commands.