From 5ffaec3eec7e5c6829c5e0e43cf0cd860a25538f Mon Sep 17 00:00:00 2001 From: Carl Gay Date: Sat, 4 May 2024 12:07:00 -0400 Subject: [PATCH] Fix doc dependency and a few grammar issues --- documentation/source/conf.py | 2 +- documentation/source/usage.rst | 14 +++++++------- dylan-package.json | 11 +++++++---- 3 files changed, 15 insertions(+), 12 deletions(-) diff --git a/documentation/source/conf.py b/documentation/source/conf.py index ec346bf..8a19b30 100644 --- a/documentation/source/conf.py +++ b/documentation/source/conf.py @@ -9,7 +9,7 @@ project = 'base64' copyright = '2024, Carl Gay' author = 'Carl Gay' -release = '0.1.1' +release = '0.2.0' # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration diff --git a/documentation/source/usage.rst b/documentation/source/usage.rst index 07237e6..b39648e 100644 --- a/documentation/source/usage.rst +++ b/documentation/source/usage.rst @@ -10,14 +10,14 @@ See also :doc:`reference` Quickstart ---------- -Add ``use base64;`` to both your library file. +Add ``use base64;`` to your library and module definitions. -This library exports two functions +This library exports two functions: -- :func:`base64-encode` and +- :func:`base64-encode` - :func:`base64-decode` -that accept a :drm:`` and returns a :drm:``. +Both functions accept a :drm:`` and return a :drm:``. Types of encoding ----------------- @@ -28,8 +28,8 @@ The functions have two types of encoding/decoding: - ``#"http"`` -The main difference between them are the padding characters used. You -can choose the type with the key parameter ``encoding:`` (see example +The main difference between them is the padding characters used. You +can choose the type with the ``encoding:`` parameter (see example below). Example @@ -62,7 +62,7 @@ Here is an example of usage of the standard encoding/decoding: HTTP encoding/decoding ~~~~~~~~~~~~~~~~~~~~~~ -To show the http encoding/decoding we will use a text that forces the +To show the HTTP encoding/decoding we will use a text that forces the padding (base64 encoding uses padding to ensure that the length of the encoded string is a multiple of 4 bytes). diff --git a/dylan-package.json b/dylan-package.json index 20f6089..087a6f1 100644 --- a/dylan-package.json +++ b/dylan-package.json @@ -1,11 +1,14 @@ { + "name": "base64", + "version": "0.2.0", + "description": "Base-64 encoding/decoding", "category": "encoding", "contact": "dylan-lang@googlegroups.com", "dependencies": [ ], - "dev-dependencies": [ "testworks" ], - "description": "Base64 encoding", - "name": "base64", - "version": "0.1.1", + "dev-dependencies": [ + "sphinx-extensions", + "testworks" + ], "url": "https://github.com/dylan-lang/base64", "keywords": [ "base64", "binary" ], "license": "Unlicensed",