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

Add example on dates data #57

Merged
merged 7 commits into from
Sep 19, 2022
Merged

Add example on dates data #57

merged 7 commits into from
Sep 19, 2022

Conversation

kklein
Copy link
Collaborator

@kklein kklein commented Sep 16, 2022

Sadly, sqlite doesn't offer date data types - otherwise I would've added coded to actually run this, as we have in the companies example[0].

Eventually, one might find a way around this, e.g. by offering a script to upload data to a postgres database - as we do in the twitch example[1].

I figured this PR would be a good start. If someone feels like turning this into an executable specification in a follow-up PR, this would of course be highly appreciated.

Rendered version: https://datajudge--57.org.readthedocs.build/en/57/examples/example_dates.html

[0] https://datajudge.readthedocs.io/en/latest/examples/example.html
[1] https://datajudge.readthedocs.io/en/latest/examples/example_twitch.html

@kklein kklein linked an issue Sep 16, 2022 that may be closed by this pull request
2 tasks
@codecov
Copy link

codecov bot commented Sep 16, 2022

Codecov Report

Merging #57 (793d9f3) into main (1944dbe) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #57   +/-   ##
=======================================
  Coverage   93.90%   93.90%           
=======================================
  Files          15       15           
  Lines        1607     1607           
=======================================
  Hits         1509     1509           
  Misses         98       98           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@kklein kklein marked this pull request as ready for review September 16, 2022 16:59
@kklein kklein requested a review from ivergara September 16, 2022 16:59
Copy link
Collaborator

@ivergara ivergara left a comment

Choose a reason for hiding this comment

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

Only minor comments.

Example: Dates
==============

This example concerns itself with expressing ``Constraint`` s against data revolving
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why do you tend to have a space character when making plurals of "formatted" words? Like here in Constraint s?

I saw the rendered version, and I think I can see a space between the word and the last letter.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I saw the rendered version, and I think I can see a space between the word and the last letter.

Same here - I don't like the look of it.

Afaict it is not valid rst to add a character right after a closing double-tick.

If I do, the build gets very messy:

Screenshot 2022-09-19 at 10 44 07 AM

docs/source/examples/example_dates.rst Outdated Show resolved Hide resolved
docs/source/examples/example_dates.rst Show resolved Hide resolved
3. The minimum value in column ``date_from`` should be the first of January 2022.
4. The maximum value in column ``date_to`` should be the 31st of January 2022.
5. There is no gap between ``date_from`` and ``date_to``. In other words, every date
of January can be assigned to at least one row.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
of January can be assigned to at least one row.
of January has to be assigned to at least one row.

docs/source/examples/example_dates.rst Show resolved Hide resolved
docs/source/examples/example_dates.rst Outdated Show resolved Hide resolved
@kklein kklein merged commit ebbbb6e into main Sep 19, 2022
@kklein kklein deleted the date-example branch September 19, 2022 12:22
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.

Extend test examples in documentation
2 participants