This repository has been archived by the owner on Nov 17, 2022. It is now read-only.
Update README #198
Merged
Update README #198
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
iati.core -> pyIATI
hayfield
added
docs
Having info about them prominently, then having them look a bit dud isn't great. Adding a warning partially helps with this problem.
There should only be single spaces between sentences.
Leaving this here adds additional maintenance burden, and this is not undertaken. The Issues are used for this purpose, and are able to adapt over time, with discussions and additional information being added. The current situation of using Issues isn't ideal, though it's not immediately obvious what a correct solution is.
Some information had become out-of-date. This brings it back in line with the latest version of the code. There is still much work to improve the README - it doesn't provide a very good introduction to somebody new to IATI.
requires.io still refers to the old repository name, and does not work with the new name.
It is useful to have multiple so that the difference between master and dev can be seen.
hayfield
added
complete
allthatilk
suggested changes
Oct 24, 2017
README.md
Outdated
|
|
||
| Usage | ||
| ===== | ||
|
|
||
| **WARNING:** This `iati.core` library is currently in active development. **All usage examples are subject to change**, as we iteratively improve functionality. Therefore, the following examples are provided for illustrative purposes only. As the library matures, this message and other documentation will be updated accordingly! | ||
| **WARNING:** This `iati.core` library is currently in active development. **All usage examples are subject to change**, as we iteratively improve functionality. Therefore, the following examples are provided for illustrative purposes only. As the library matures, this message and other documentation will be updated accordingly! |
There was a problem hiding this comment.
Exclamation marks are probably overkill lol
There was a problem hiding this comment.
Also mentions iati.core
Remove a reference to iati.core Remove an unnecessary exclamation mark
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Various small fixes and improvements to the README.