From 19b149c5c2b920eca66ba5d6b52ea0f31c7a9e80 Mon Sep 17 00:00:00 2001 From: Ethan Paul <24588726+enpaul@users.noreply.github.com> Date: Thu, 4 May 2023 14:55:56 -0400 Subject: [PATCH] Remove source code links from readme to support cross platform pubs These links would change whenever there was a software update and never worked on PyPI, so it's best to just remove them --- CODE_OF_CONDUCT.md | 15 ++++++++------- README.md | 25 ++++++++++++------------- 2 files changed, 20 insertions(+), 20 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 2382d9d..0530753 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -27,9 +27,10 @@ Examples of unacceptable behavior include: - The use of sexualized language or imagery, and sexual attention or advances of any kind - Trolling, insulting or derogatory comments, and personal or political attacks - Public or private harassment -- Publishing others' private information, such as a physical or email address, without their - explicit permission -- Other conduct which could reasonably be considered inappropriate in a professional setting +- Publishing others' private information, such as a physical or email address, without + their explicit permission +- Other conduct which could reasonably be considered inappropriate in a professional + setting ## Enforcement Responsibilities @@ -52,8 +53,8 @@ offline event. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the -community leaders responsible for enforcement at \[INSERT CONTACT METHOD\]. All -complaints will be reviewed and investigated promptly and fairly. +community leaders responsible for enforcement at \[INSERT CONTACT METHOD\]. All complaints +will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the reporter of any incident. @@ -105,8 +106,8 @@ toward or disparagement of classes of individuals. This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. -Community Impact Guidelines were inspired by [Mozilla's code of conduct -enforcement ladder](https://github.com/mozilla/diversity). +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at diff --git a/README.md b/README.md index af1a2b4..fe19862 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,8 @@ release history. ## Documentation -*The documentation for this project is currently a work in progress. Please see the source code for complete docs* +*The documentation for this project is currently a work in progress. Please see the source +code for complete docs* - [Installing](#installing) - [Features](#features) @@ -57,34 +58,32 @@ when using SQLite ### Functions -[`calc_batch_size`](blob/devel/peewee_plus.py#L93) - Helper function for writing -backend-agnostic batch queries while accounting for the +`calc_batch_size` - Helper function for writing backend-agnostic batch queries while +accounting for the [SQLite max variable limit](https://www.sqlite.org/limits.html#max_variable_number). -[`flat_transaction`](blob/devel/peewee_plus.py#L159) - Decorator function for wrapping -callables in a database transaction without creating nested transactions +`flat_transaction` - Decorator function for wrapping callables in a database transaction +without creating nested transactions ### Classes -[`PathField`](blob/devel/peewee_plus.py#204) - A Peewee database field for storing +`PathField` - A Peewee database field for storing [Pathlib](https://docs.python.org/3/library/pathlib.html) objects, optionally relative to a runtime value. -[`PrecisionFloatField`](blob/devel/peewee_plus.py#L262) - A Peewee database field for -storing floats while specifying the +`PrecisionFloatField` - A Peewee database field for storing floats while specifying the [MySQL precision parameters](https://dev.mysql.com/doc/refman/8.0/en/floating-point-types.html) `M` and `D` -[`JSONField`](blob/devel/peewee_plus.py#L293) - A Peewee database field for storing -arbitrary JSON-serializable data +`JSONField` - A Peewee database field for storing arbitrary JSON-serializable data -[`EnumField`](blob/devel/peewee_plus.py#L348) - A Peewee database field for storing Enums -by name +`EnumField` - A Peewee database field for storing Enums by name ## For Developers All project contributors and participants are expected to adhere to the -[Contributor Covenant Code of Conduct, v2](CODE_OF_CONDUCT.md) ([external link](https://www.contributor-covenant.org/version/2/0/code_of_conduct/)). +[Contributor Covenant Code of Conduct, v2](CODE_OF_CONDUCT.md) +([external link](https://www.contributor-covenant.org/version/2/0/code_of_conduct/)). The `devel` branch has the latest (and potentially unstable) changes. The stable releases are tracked on [Github](https://github.com/enpaul/peewee-plus/releases),