Updated doc #1
Updated doc #1
Conversation
To make README easier to read.
To avoid confusion and distraction.
jonathanbaker7
left a comment
jonathanbaker7
left a comment
There was a problem hiding this comment.
Let me know if you have any questions, or need clarification on anything...
README.md
Outdated
| - [requests == 2.20.0](https://pypi.org/project/requests/2.20.0/) | ||
| - [enum34 >= 1.0.4](https://pypi.org/project/enum34/) | ||
| - [funcsigs >= 1.0.2](https://pypi.org/project/funcsigs/) | ||
| - [lxml >= 3.7.3](https://pypi.org/project/lxml/) |
There was a problem hiding this comment.
These last four items. I believe these libraries would automatically be added by pip. Correct? If so, they aren't necessary here, and you should remove them. This list is just the things the user must have installed to make this work.
Feel free to put these in a separate reference section, near the bottom, if you want to show which libraries you are using for reference purposes.
There was a problem hiding this comment.
But you don't have to.
README.md
Outdated
| for smith in smith_employees_request.execute(): | ||
| print(smith.EmployeeID) | ||
| ``` | ||
| This projects is issue-free. Should you have any doubts, please, consult [our issue tracker](https://github.com/SAP/python-pyodata/issues). |
There was a problem hiding this comment.
OK. So, all software has bugs. That's a certainty. What you should say here is:
There are no known issues at this time.
README.md
Outdated
| ## How to obtain support | ||
|
|
||
| You need to use the method set which accepts key value parameters: | ||
| We provide unclaimable support via [GitHub issues](https://github.com/SAP/python-pyodata/issues) |
There was a problem hiding this comment.
Absolutely no legal language
This is not a criticism, it's on the advice from our legal team. We aren't lawyers, and lawyers aren't programmers. We don't do legal, they don't do code. So, I try to stay away from anything that sounds like legal lingo.
Please change this to say
We accept bug reports via ..
README.md
Outdated
|
|
||
| Find more sophisticated examples in the [USAGE](USAGE.md) section. | ||
|
|
||
| # Contributing |
There was a problem hiding this comment.
| # Contributing | |
| ## Contributing |
README.md
Outdated
| they can. | ||
|
|
||
| ## Tips & tricks | ||
| # License |
There was a problem hiding this comment.
| # License | |
| ## License |
README.md
Outdated
|
|
||
| make check | ||
| ``` | ||
| the Apache Software License, v. 2 |
There was a problem hiding this comment.
| the Apache Software License, v. 2 | |
| the Apache Software License, v. 2 |
There was a problem hiding this comment.
No need to make this a code block. The text is boilerplate, and should read as follows:
Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved.
This file is licensed under the [XXX} except as noted otherwise in the LICENSE file [include link to the LICENSE file in your project repository].”
|
@jonathanbaker7 I've added few more commits that should address your findings. Thank you very much! |
jonathanbaker7
left a comment
jonathanbaker7
left a comment
There was a problem hiding this comment.
This looks good. I've modified one thing - the title - and otherwise I think you are ready to go. It is approved. Once it is merged, please email me so I can make your project public.
I didn't expect that metadata will be send in anything else that ASCII. But we absolutely need to know the charse because of labels. Northwind returns "Content-Type: application/xml;charset=utf-8" Closes SAP#1
I didn't expect that metadata will be send in anything else that ASCII. But we absolutely need to know the charse because of labels. Northwind returns "Content-Type: application/xml;charset=utf-8" Closes SAP#1
I didn't expect that metadata will be send in anything else that ASCII. But we absolutely need to know the charse because of labels. Northwind returns "Content-Type: application/xml;charset=utf-8" Closes #1
2 participants
No description provided.