Git Product home page Git Product logo

Comments (2)

stscicrawford avatar stscicrawford commented on July 28, 2024

@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.

mperrin avatar mperrin commented on July 28, 2024

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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.