Code Monkey home page Code Monkey logo

Comments (7)

sophieclayton avatar sophieclayton commented on September 15, 2024

+1

this would be incredibly helpful for "outside" users of myria like me.

from myria-web.

dhalperi avatar dhalperi commented on September 15, 2024

Here is an example template for such a page. Each of the links is a link directly to a Wiki page named after the keyword.

screen shot 2014-10-23 at 10 53 09 pm

Thoughts, anyone @uwescience/myria ?

from myria-web.

domoritz avatar domoritz commented on September 15, 2024

Sweet. We could also auto generate documentation from the repo with readthedocs. It's easy to set up and up to date with the code. A simple example is http://dataset.readthedocs.org/

from myria-web.

dhalperi avatar dhalperi commented on September 15, 2024

Here's a thought: at one point, we were talking about making functions case-sensitive, weren't we? If so, things like the safediv keyword we use here would be lies...

(Right now, it seems to work: this program parses.

x = empty(y:float);
z = select safediv(5, y, 10) from x;
store(z, ans);

even though the function is named SafeDiv in raco. https://github.com/uwescience/raco/blob/master/raco/expression/expressions_library.py#L34)

from myria-web.

dhalperi avatar dhalperi commented on September 15, 2024

Hmm. Last I checked, readthedocs was exceptionally burdensome and a fairly bad fit for example-driven documentation. Note that we do NOT want to show the same docs we show to developers here -- we want docs meant for someone who is not at all used to looking at Python code. The docs we want to show here have essentially nothing to do with Python itself or the code structure in raco.

(E.g.,: how would we document the expressions library?)

from myria-web.

domoritz avatar domoritz commented on September 15, 2024

Fair enough. Since the expressions are scattered across the code and are initialized differently (as functions, composed, ...) it would probably be a pain to make it work with rtd.

from myria-web.

domoritz avatar domoritz commented on September 15, 2024

Here's a thought: at one point, we were talking about making functions case-sensitive, weren't we? If so, things like the safediv keyword we use here would be lies...

I was promised case sensitivity when I implement syntax highlighting, I remember ;-)

cc @7andrew7

from myria-web.

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.