Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

code integration #84

Open
PhilippMayr opened this issue Mar 6, 2017 · 4 comments
Open

code integration #84

PhilippMayr opened this issue Mar 6, 2017 · 4 comments
Assignees

Comments

@PhilippMayr
Copy link
Member

PhilippMayr commented Mar 6, 2017

in WP 2 we talk about code integration in fidus.
I suggest to create a project in our OSCOSS git and place some R code there which should be used by some demo documents

"We will add a “code lookup” functionality, initially connected to the GitHub hosting service for software source code repositories."

@johanneswilm
Copy link
Collaborator

Is the idea that this simply lets the user display code snippets in the document? Or are these code snippets to be executed? If this is the case, we we will need to figure out how to do this in each of the output formats.

@afshinsadeghi
Copy link
Collaborator

To my point of view, it is the feature to

  1. support their storage and
    2 support for showing them in the text and
    3.updating them automatically in the doc if the source code is updated.

@johanneswilm
Copy link
Collaborator

Support for showing in the text (point 2) is present already.

As for point 3: I am not so sure this is always a good idea. If one links to a function within a github project to demonstrate something, and then that function changes fundamentally and it is automatically updated in the text, then the explanatory text around it will no longer make much sense. At least there should be a way to stop the automatic change from happening (a confirmation dialog or alike).

@afshinsadeghi
Copy link
Collaborator

This is moved the next Phase of the project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants