search

kbase / kb_sdk

Build and test new apps for the KBase platform
http://kbase.github.io/kb_sdk_docs
MIT License
27 stars 32 forks source link

minor documentation updates #274

Closed nixonpjoshua closed 6 years ago

nixonpjoshua commented 7 years ago

these are just some small fixes I forgot to make a PR for I made when I was going to through the SDK documentation

nixonpjoshua commented 6 years ago

I think that the issues I had were related to the sdk not caring the case of letters I put in for module names while the filesystem did care once files were created for the modules. This caused some errors for me and I had initially thought that the module names were cased differently as by doing that I was able to make my app work.

I added a warning into the documentation about this pitfall.

alternatively this could be considered a bug in the SDK and the SDK could be made to only match module names in a case-sensitive way which I believe would make this pitfall no longer exist.

nlharris commented 6 years ago

I think @thebenallen made some changes after @nixonpjoshua made a few edits. Can you guys check if I merged the changes correctly?