Merge branch 'master' into log

This commit is contained in:
Andrew Head 2019-03-06 17:12:29 -08:00 коммит произвёл GitHub
Родитель 97cedd462a 4d06b4fb81
Коммит 8d1b93c408
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
4 изменённых файлов: 57 добавлений и 74 удалений

Просмотреть файл

@ -97,7 +97,7 @@ npm publish --access=restricted # make this public eventually
### Troubleshooting
### `500` message when launching Jupyter notebook
#### `500` message when launching Jupyter notebook
Install these versions of Jupyter notebook and dependencies
to see something working, before trying out other versions:
@ -107,3 +107,10 @@ nbconvert==5.3.1
nbformat==4.4.0
notebook==5.6.0
```
#### Build errors
* **Errors about missing semicolons in React types files**: upgrade the `typescript` and `ts-node` packages
* **Conflicting dependencies**: upgrade either the Python Jupyter Lab (may require Python upgrade to Python 3 to get the most recent version of Jupyter Lab) or the Jupyter Lab npm pacakges
* **Issues with duplicated React types**: download React types in `@jupyterlab/` packages
* **Other issues**: delete your node_modules files and reinstall them

Просмотреть файл

@ -1 +1,4 @@
theme: jekyll-theme-leap-day
title: Code Gathering Tools
theme: minima
description: Tools for cleaning, recovering, and comparing versions of code in computational notebooks
author: Andrew Head, Fred Hohman, Titus Barik, Steven M. Drucker, and Robert DeLine

Просмотреть файл

@ -0,0 +1,37 @@
<footer class="site-footer h-card">
<data class="u-url" href="{{ "/" | relative_url }}"></data>
<div class="wrapper">
{% comment %}
<h2 class="footer-heading">{{ site.title | escape }}</h2>
{% endcomment %}
<div class="footer-col-wrapper">
<div class="footer-col footer-col-1">
<ul class="contact-list">
<li class="p-name">
{%- if site.author -%}
{{ site.author | escape }}
{%- else -%}
{{ site.title | escape }}
{%- endif -%}
</li>
{%- if site.email -%}
<li><a class="u-email" href="mailto:{{ site.email }}">{{ site.email }}</a></li>
{%- endif -%}
</ul>
</div>
<div class="footer-col footer-col-2">
{%- include social.html -%}
</div>
<div class="footer-col footer-col-3">
<p>{{- site.description | escape -}}</p>
</div>
</div>
</div>
</footer>

Просмотреть файл

@ -1,77 +1,13 @@
---
layout: default
title: Code gathering tools
title:
---
# Code gathering tools
# Coming soon
Code gathering tools help you clean, recover, and compare
versions of code in computational notebooks.
For instance, with code gathering tools, you can select a
result in your notebook, and then create an entirely new
notebook with nothing but the subset of cells, in order,
that were used to compute it.
# Installing gathering tools
This command doesn't currently work, but it will soon!
```
jupyter labextension install gather
```
# Using gathering tools
*TODO: Add a bunch of GIFs here. Show examples of gathering
to notebook, gathering to cells, gathering to scripts, and
gathering history.*
# Learn More
Curious about how we designed and built code gathering
tools? Read our technical paper!
**Managing Messes in Computational Notebooks**. Andrew Head,
Fred Hohman, Titus Barik, Steven Drucker, and Robert
DeLine. To appear at the ACM Conference on Human Factors in
Computing Systems, CHI 2019.
*A link to pre-print will be posted soon!*
Replication materials for the in-lab usability study can be
found [here (TODO)](broken link).
# Questions and Answers
**Will my notebook take up more storage space when I use
this extension?**
Yes, by design. To help you recover code that has been
deleted or overwritten, your notebook will be saved with all
lines of code you executed in it. That said, the
storage space of this text should be small compared to the
outputs saved in the notebook.
**Will this extension make my notebook run slower?**
Hopefully not. If it does, let us know by [submitting a bug
request](https://github.com/Microsoft/gather/issues/new/choose).
**The paper had a feature where you could compare versions
of cell outputs side by side. How do I enable that?**
We're hoping to add that feature back into the tool soon.
When we do, we'll update this answer with details.
**I found a bug. Can you fix it?**
[Submit a bug request](https://github.com/Microsoft/gather/issues/new/choose)
and we'll see what we can do.
**This is tool [extremely / somewhat / not that] useful.**
We're actively working on improving these tools to help
analysts manage messes in their notebooks. Submit a feature
request if you have an idea of something we should add. Or
just send us an email telling us about how you use them.
*Code gathering tools* are extensions to computational
notebooks that help you clean, recover, and compare versions
of messy code. [Email us](mailto:andrewhead@berkeley.edu) if
you'd like to participate in our alpha roll-out, or if you
would like to be notified of their release in the coming
months.