Comments (2)
@eteq : Along the lines of @nden's suggestion about setting up environments: it might also be good to have a recommendation for setting up the development environment. E.g. "Use python setup.py develop if it's pure-python, or python setup.py build and run from the build directory if not. Use conda environments to manage dependencies."
from style-guides.
I like the idea of including reference to such tools directly in the style guide, to keep that info in the same place as the style recommendations. I think that will be more helpful to more users if we say, e.g. "you should do X, and here is a tool that will help you automate doing X". Typically I don't think this would be detailed usage instructions or procedures for these tools, but rather a brief mention and hyperlink to point the reader to such descriptions elsewhere.
Ideally there might be distinctive formatting (perhaps a colored text box, a la what Sphinx's .. hint::
markup produces?) that would distinguish the "here is a helpful tool" text from the surrounding "here are some style recommendations" text. Not sure how best to do that formatting in Jupyter Markdown though; just direct HTML div/span and CSS code added in those cells?
from style-guides.
Related Issues (20)
- This thing needs to be managed and advertised HOT 2
- Present this in TIPS and EngOps in 2020 HOT 1
- Badge for packages that follow style guide HOT 2
- Distribute flyers around STScI HOT 1
- Update python packaging information
- Organize a hack day in 2020 HOT 1
- Create a ROADMAP
- Ditch Travis CI as a recommended solution HOT 4
- Update Master Branch
- Notebook accessibility from Scipy 2023
- Adopt the Scientific Python Developers Guide
- Web style guide should link to branding page
- Add astroconda to release guide
- Microservices style guide HOT 1
- Testing style guide: Discourage Travis CI, find replacement? HOT 2
- Add information about how to cite software HOT 1
- Notebook style guide: Footer instruction confusing HOT 1
- Review security style guide HOT 2
- Community Name for Zenodo Software DOI? HOT 1
- Detailed Zenodo instructions for new software DOI? HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from style-guides.