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

[doc] Improve documentation for binaries #666

Merged
merged 6 commits into from
Jul 1, 2020

Conversation

woshilapin
Copy link
Contributor

Ref. ND-929

Copy link
Contributor

@pbougue pbougue left a comment

Choose a reason for hiding this comment

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

The point of this PR as I understood it was to have all sub-readme very similars.

Any diff with gtfs2netexfr/README.md should be just about specificities of the bin:

  • If using proj, the topo should be the same (no mention of the version, just in main readme)
  • adding/removing specific required params
  • same topo on the NeTEx manual-check (link will change with [doc] Improve contributing #665 : rebase!)
  • Maybe some other diffs I didn't spot for restrict or ntfs2ntfs ?

So current work is good for me, but I think there is a little more changes to do on sub-readmes.

@woshilapin
Copy link
Contributor Author

The point of this PR as I understood it was to have all sub-readme very similars.

Any diff with gtfs2netexfr/README.md should be just about specificities of the bin:

* If using proj, the topo should be the same (no mention of the version, just in main readme)

* adding/removing specific required params

* same topo on the NeTEx manual-check (link will change with #665 : rebase!)

* Maybe some other diffs I didn't spot for `restrict` or `ntfs2ntfs` ?

So current work is good for me, but I think there is a little more changes to do on sub-readmes.

So, here is the last modifications I made:

  • I remove the section about configuration in gtfs2ntfs/README.md (it is already covered by the --help option
  • I removed the PROJ version from ntfs2netexfr (already mentioned in CONTRIBUTING.md)
  • I added a link to the section check the output manually in ntfs2netexfr (and I rebased for that)

@datanel datanel merged commit bc46cd6 into hove-io:master Jul 1, 2020
@woshilapin woshilapin deleted the doc-crates branch July 1, 2020 16:20
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.

3 participants