Skip to content

Commit

Permalink
Renames viper to vyper in the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jacqueswww committed Jan 10, 2018
1 parent 8588835 commit 23e29b8
Show file tree
Hide file tree
Showing 14 changed files with 91 additions and 976 deletions.
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = python -msphinx
SPHINXPROJ = Viper
SPHINXPROJ = Vyper
SOURCEDIR = .
BUILDDIR = _build

Expand Down
4 changes: 2 additions & 2 deletions docs/built-in-functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Built in Functions
***********************

Viper contains a set amount of built in functions that would be timely and/or unachievable to write in Viper.
Vyper contains a set amount of built in functions that would be timely and/or unachievable to write in Vyper.

.. _functions:

Expand Down Expand Up @@ -157,7 +157,7 @@ Takes a function declaration and returns its method_id (used in data field to ca
"""
:param hash: a signed hash
:type hash: bytes32
:param v:
:param v:
:type v: num256
:param r: elliptic curve point
:type r: num256
Expand Down
10 changes: 5 additions & 5 deletions docs/compiling-a-contract.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ Compiling a Contract
####################
To compile a contract, use:
::
viper yourFileName.v.py
vyper yourFileName.v.py

.. note::
.. note::
Since .vy is not officially a language supported by any syntax highlighters or linters,
it is recommended to name your Viper file ending with `.v.py` in order to have Python syntax highlighting.
it is recommended to name your Vyper file ending with `.vy` or optionally `.v.py` in order to have Python syntax highlighting.

An `online compiler <https://viper.tools/>`_ is available as well, which lets you experiment with
the language without having to install Viper. The online compiler allows you to compile to ``bytecode`` and/or ``LLL``.
the language without having to install Vyper. The online compiler allows you to compile to ``bytecode`` and/or ``LLL``.

.. note::
While the viper version of the online compiler is updated on a regular basis it might
While the vyper version of the online compiler is updated on a regular basis it might
be a bit behind the latest version found in the master branch of the repository.
18 changes: 8 additions & 10 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Viper documentation build configuration file, created by
# Vyper documentation build configuration file, created by
# sphinx-quickstart on Wed Jul 26 11:18:29 2017.
#
# This file is execfile()d with the current directory set to its
Expand All @@ -22,7 +22,7 @@
# sys.path.insert(0, os.path.abspath('.'))
from recommonmark.parser import CommonMarkParser

# TO DO - Create and Implement Viper Lexer
# TO DO - Create and Implement Vyper Lexer
# def setup(sphinx):
# sys.path.insert(0, os.path.abspath('./utils'))
# from SolidityLexer import SolidityLexer
Expand Down Expand Up @@ -55,7 +55,7 @@
master_doc = 'index'

# General information about the project.
project = 'Viper'
project = 'Vyper'
copyright = '2017, Vitalik Buterin'
author = 'Vitalik Buterin'

Expand Down Expand Up @@ -124,7 +124,7 @@
# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'Viperdoc'
htmlhelp_basename = 'Vyperdoc'


# -- Options for LaTeX output ---------------------------------------------
Expand All @@ -151,7 +151,7 @@
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'Viper.tex', 'Viper Documentation',
(master_doc, 'Vyper.tex', 'Vyper Documentation',
'Vitalik Buterin', 'manual'),
]

Expand All @@ -161,7 +161,7 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'viper', 'Viper Documentation',
(master_doc, 'vyper', 'Vyper Documentation',
[author], 1)
]

Expand All @@ -172,8 +172,8 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'Viper', 'Viper Documentation',
author, 'Viper', 'One line description of project.',
(master_doc, 'Vyper', 'Vyper Documentation',
author, 'Vyper', 'One line description of project.',
'Miscellaneous'),
]

Expand All @@ -182,5 +182,3 @@
}

source_suffix = ['.rst', '.md']


22 changes: 11 additions & 11 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Contributing

Help is always appreciated!

To get started, you can try `installing Viper <https://viper.readthedocs.io/en/latest/installing-viper.html>`_ in order to familiarize
yourself with the components of Viper and the build process. Also, it may be
useful to become well-versed at writing smart-contracts in Viper.
To get started, you can try `installing Vyper <https://vyper.readthedocs.io/en/latest/installing-vyper.html>`_ in order to familiarize
yourself with the components of Vyper and the build process. Also, it may be
useful to become well-versed at writing smart-contracts in Vyper.

Types of Contributions
======================
Expand All @@ -15,27 +15,27 @@ In particular, we need help in the following areas:

* Improving the documentation
* Responding to questions from other users on `StackExchange
<https://ethereum.stackexchange.com>`_ and the `Viper Gitter
<https://gitter.im/ethereum/viper>`_
<https://ethereum.stackexchange.com>`_ and the `Vyper Gitter
<https://gitter.im/ethereum/vyper>`_
* Suggesting Improvements
* Fixing and responding to `Viper's GitHub issues <https://github.com/ethereum/viper/issues>`_
* Fixing and responding to `Vyper's GitHub issues <https://github.com/ethereum/vyper/issues>`_



How to Suggest Improvements
===========================

To suggest an improvement, please create a Viper Improvement Proposal (VIP for short)
using the `VIP Template <https://github.com/ethereum/viper/tree/master/.github/VIP_TEMPLATE.md>`_.
To suggest an improvement, please create a Vyper Improvement Proposal (VIP for short)
using the `VIP Template <https://github.com/ethereum/vyper/tree/master/.github/VIP_TEMPLATE.md>`_.

How to Report Issues
====================

To report an issue, please use the
`GitHub issues tracker <https://github.com/ethereum/viper/issues>`_. When
`GitHub issues tracker <https://github.com/ethereum/vyper/issues>`_. When
reporting issues, please mention the following details:

* Which version of Viper you are using
* Which version of Vyper you are using
* What was the source code (if applicable)
* Which platform are you running on
* Your operating system name and version
Expand All @@ -49,7 +49,7 @@ very helpful and sometimes even clarifies a misunderstanding.
Fix Bugs
========

Find or report bugs at our `issues page <https://github.com/ethereum/viper/issues>`_. Anything tagged with "bug" is open to whoever wants to implement it.
Find or report bugs at our `issues page <https://github.com/ethereum/vyper/issues>`_. Anything tagged with "bug" is open to whoever wants to implement it.

Workflow for Pull Requests
==========================
Expand Down
26 changes: 13 additions & 13 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
.. Viper documentation master file, created by
.. Vyper documentation master file, created by
sphinx-quickstart on Wed Jul 26 11:18:29 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
#####
Viper
Vyper
#####

Viper is an **experimental**, contract-oriented, pythonic programming language that targets the `Ethereum Virtual Machine (EVM) <http://ethdocs.org/en/latest/introduction/what-is-ethereum.html#ethereum-virtual-machine>`_
Vyper is an **experimental**, contract-oriented, pythonic programming language that targets the `Ethereum Virtual Machine (EVM) <http://ethdocs.org/en/latest/introduction/what-is-ethereum.html#ethereum-virtual-machine>`_

********************
Principles and Goals
********************

* **Security:** It should be possible and natural to build secure smart-contracts in Viper.
* **Security:** It should be possible and natural to build secure smart-contracts in Vyper.
* **Language and compiler simplicity:** The language and the compiler implementation should strive to be simple.
* **Auditability:** Viper code should be maximally human-readable. Furthermore, it should be maximally difficult to write misleading code. Simplicity for the reader
is more important than simplicity for the writer, and simplicity for readers with low prior experience with Viper (and low prior experience with programming in
* **Auditability:** Vyper code should be maximally human-readable. Furthermore, it should be maximally difficult to write misleading code. Simplicity for the reader
is more important than simplicity for the writer, and simplicity for readers with low prior experience with Vyper (and low prior experience with programming in
general) is particularly important.

Because of this Viper aims to provide the following features:
Because of this Vyper aims to provide the following features:

* **Bounds and overflow checking:** On array accesses as well as on arithmetic level.
* **Support for signed integers and decimal fixed point numbers**
Expand All @@ -28,10 +28,10 @@ Because of this Viper aims to provide the following features:
* **Small and understandable compiler code**
* **Limited support for pure functions:** Anything marked constant is not allowed to change the state.

Following the principles and goals, Viper **does not** provide the following features:
Following the principles and goals, Vyper **does not** provide the following features:

* **Modifiers**: For example in Solidity you can define a ``function foo() mod1 { ... }``, where ``mod1`` can be defined elsewhere in the code to include a check that is done before execution,
a check that is done after execution, some state changes, or possibly other things. Viper does not have this, because it makes it too easy to write misleading code. ``mod1`` just looks
a check that is done after execution, some state changes, or possibly other things. Vyper does not have this, because it makes it too easy to write misleading code. ``mod1`` just looks
too innocuous for something that could add arbitrary pre-conditions, post-conditions or state changes. Also, it encourages people to write code where the execution jumps around the file,
harming auditability. The usual use case for a modifier is something that performs a single check before execution of a program; our recommendation is to simply inline these checks as asserts.
* **Class inheritance:** Class inheritance requires people to jump between multiple files to understand what a program is doing, and requires people to understand the rules of precedence in case of conflicts
Expand All @@ -48,7 +48,7 @@ Following the principles and goals, Viper **does not** provide the following fea
Compatibility-breaking Changelog
********************************

* **2017.12.25**: Change name from Viper to Vyper
* **2017.12.25**: Change name from Vyper to Vyper
* **2017.12.22**: Add ``continue`` for loops
* **2017.11.29**: ``@internal`` renamed to ``@private``.
* **2017.11.15**: Functions require either ``@internal`` or ``@public`` decorators.
Expand All @@ -63,9 +63,9 @@ Glossary
.. toctree::
:maxdepth: 2

installing-viper.rst
installing-vyper.rst
compiling-a-contract.rst
viper-by-example.rst
viper-in-depth.rst
vyper-by-example.rst
vyper-in-depth.rst
contributing.rst
frequently-asked-questions.rst
146 changes: 0 additions & 146 deletions docs/installing-viper.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/make.bat
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ if "%SPHINXBUILD%" == "" (
)
set SOURCEDIR=.
set BUILDDIR=_build
set SPHINXPROJ=Viper
set SPHINXPROJ=Vyper

if "%1" == "" goto help

Expand Down
Loading

0 comments on commit 23e29b8

Please sign in to comment.