Update documentation for adding new features#108
Conversation
|
@milenaveneziani, could you let me know if the updated documentation helps to understand my requested changes in #106? |
xylar
force-pushed
the
fix_add_feature_docs
branch
from
5d621ae to
4a6d896
Compare
|
@mark-petersen, I'm hoping the second commit here will help with: |
docs/adding_features.rst
Outdated
| It is not recommended that you modified features directly in | ||
| ``geometric_data``, but if you have already done so, you can update the | ||
| manifst of all features and tags based on your changes first, then merge your | ||
| features into a feature colleciton and then split it back out into individual |
There was a problem hiding this comment.
couple of typos above
|
|
||
| # Make a geometric features object that gets data from a local cache in | ||
| # ./geometric_data. (The remote branch won't matter.) | ||
| gf = GeometricFeatures(cacheLocation='./geometric_data') |
There was a problem hiding this comment.
so this will also make sure that it dos 'not' download data from the main repo if it doesn't find it in the local repo, right?
There was a problem hiding this comment.
In general, gf will still try to download anything you request that it doesn't find in the local cache. It does this by looking at the manifest, so by updating the manifest to match the local cache first, you ensure that it's not going to try to download anything.
|
@xylar: how is one supposed to access the documentation for geometric_features? By looking into the docs/? Perhaps I missed it, but if not, it would be nice to add a sentence in the README so that it is visible when opening the repo on github. |
|
Yeah, that's a problem. There isn't currently a good way to look at the docs. It needs to be published on Read The Docs and then the README needs to be updated to point to it. I have this on my "to do" list but haven't had time. I'll make it a priority. I'm flying back to the US tomorrow so maybe on Monday. |
|
That's fine. I'd say just add a sentence in the README (something like 'For more details on the best way to add features and update this repo, please browse the documents in docs/). |
|
It doesn't look hard to get things up and running on Read The Docs, so I went ahead and set it up. We won't know if it worked until this PR gets merged. I put a link to where the docs should appear at the top of the README. |
xylar
force-pushed
the
fix_add_feature_docs
branch
2 times, most recently
from
7d9e9a6 to
fd538b7
Compare
|
great thanks. You can merge this, from my point of view. |
Fix an incorrect help string in merge_features
This makes it easier to access the entry points when running from a local git repo.
xylar
force-pushed
the
fix_add_feature_docs
branch
from
fd538b7 to
82639c6
Compare
|
@mark-petersen, you can let me know later if the stubs aren't working for you for some reason. I'll merge as soon as I see if #109 worked as expected. |
3 participants
Fix an incorrect help string in merge_features
Add back stubs for all entry points. This makes it easier to access the entry points when running
from a local git repo.