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

Add some documentation #896

Merged
merged 1 commit into from
Feb 20, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 18 additions & 7 deletions src/jupyter_contrib_nbextensions/nbextensions/freeze/readme.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,24 @@
# Freeze

This extension allows to make cells read-only or frozen.
This extension allows to make cells read-only or frozen. It provides three buttons:
* unlock
* read-only
* frozen

If a code cell is read-only, it can be executed, but its input cannot be changed.
Frozen code cells cannot be either altered or executed.

If a markdown cell is read-only, its input can be viewed by double-clicking on it, but cannot be changed.
Frozen markdown cells' input cannot be viewed by double-clicking.
For **code-cells**:<br>
_read-only_: it can be executed, but its input cannot be changed.<br>
_frozen_: It cannot be either altered or executed.

To change cells' state, select them and press corresponding button.
For **markdown-cells**:<br>
_read-only_: It's input can be viewed by double-clicking on it, but cannot be changed.<br>
_frozen_: Input cannot be viewed by double-clicking.

Cell's state is stored in its metadata and is applied to the cell if the extension is loaded.
To change the state of a selected cell, press the corresponding button.

The individual cell's state is stored in its metadata and is applied to the cell if the extension is loaded.

##Internals

The _read-only_ state is stored in the `cell.metadata.run_control.read_only` attribute.
The _frozen_ state is stored in the `cell.metadata.run_control.frozen`attribute.