search

TUM-Dev / eat-api

Simple static API for some (student) food places in Munich.
https://eat-api.tum.sexy
MIT License
21 stars 13 forks source link

Update README #47

Closed lukasdenk closed 2 years ago

lukasdenk commented 2 years ago

The README contains some old parts. E.g., it announces a change which will happen in 2020. If you recognize other parts to update, please leave a comment.

Philipp000 commented 2 years ago

The output of the help command in the README.md is not the same as the one you get by entering the command. While the one in the README.md includes all parameters, in the terminal I'm missing a few ones:

eat-api % python src/main.py -h
usage: main.py [-h] [-p LOCATION] [-d DATE] [-j PATH] [-c] [--openmensa PATH] [-l]

optional arguments:
  -h, --help            show this help message and exit
  -p LOCATION, --parse LOCATION
                        the location you want to eat at
  -l, --locations       prints all available locations formated as JSON

I think the output in the README is better, but it can be confusing, that they are different. I haven't figured how to fix the output, but I'm quite sure, that the issue is regarding to the mutually exclusive parse groups: https://github.com/TUM-Dev/eat-api/blob/69e04ad412d4f0d5687f38daf405780e27efc3b2/src/cli.py#L23

COM8 commented 2 years ago

Yes, I agree. The README.m could be updated a bit like removing the "will happen in 2020" and fixing the example.

COM8 commented 2 years ago

Closing this for now in favor of #98. As soon as we got the documentation for the API endpoint up and running we declutter the README.md even more.