From 8af61c920e4ee208157260866a0f4f122e9863a0 Mon Sep 17 00:00:00 2001 From: Andrew McCluskey Date: Mon, 23 Mar 2020 15:03:29 +0000 Subject: [PATCH 1/2] add a brief discussion of coding style --- README.md | 12 ++++++++++++ content/contributing.md | 7 +++++++ content/intro.md | 8 ++++++++ 3 files changed, 27 insertions(+) diff --git a/README.md b/README.md index 8e4c4ef..eeb4390 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ # intro_python_chemists [![intro_python_chemists](https://circleci.com/gh/pythoninchemistry/intro_python_chemists.svg?style=svg)](https://circleci.com/gh/pythoninchemistry/intro_python_chemists) +[![DOI](https://zenodo.org/badge/248480226.svg)](https://zenodo.org/badge/latestdoi/248480226) + +This is an open-source project to develop an introductory textbook covering all aspects of Python programming for chemistry students (or all career positions). + +If you would like to be involved, please look at the [contributing guidelines](https://github.com/pythoninchemistry/intro_python_chemists/blob/master/content/contributing.md). + +## On coding style + +In this book we prioritise readibility and understandability of code over everything else. +Therefore, the code herein will **not** necessarily adhere to PEP8 or any other standard, in particular if it sacrifices the educational utility of the material. +**All** issues opened that are based purely on standard adherence **will** be closed without considering. +However, we are open to issues and pull requests that discuss/improve coding style **if** the focus is on making the code clearer for the learner. \ No newline at end of file diff --git a/content/contributing.md b/content/contributing.md index d68ed61..abf8410 100755 --- a/content/contributing.md +++ b/content/contributing.md @@ -41,6 +41,13 @@ is difficult to describe as one unit of work, please consider splitting it into **Projects** are used to describe the broader picture of the `intro_python_chemists` project. More information about the overall project plan can be found on the Github [projects page](https://github.com/pythoninchemistry/intro_python_chemists/projects). +## On coding style + +In this book we prioritise readibility and understandability of code over everything else. +Therefore, the code herein will **not** necessarily adhere to PEP8 or any other standard, in particular if it sacrifices the educational utility of the material. +**All** issues opened that are based purely on standard adherence **will** be closed without considering. +However, we are open to issues and pull requests that discuss/improve coding style **if** the focus is on making the code clearer for the learner. + ## Making a contribution The most likely place that you will contribute is in the [`content`](https://github.com/pythoninchemistry/intro_python_chemists/tree/master/content) of the book. diff --git a/content/intro.md b/content/intro.md index 215f18f..eaaf326 100644 --- a/content/intro.md +++ b/content/intro.md @@ -33,6 +33,14 @@ If you would like to be involved, please look at the [contributing guidelines](h 2. [Classes](https://pythoninchemistry.org/intro_python_chemists/advanced/classes.html) 3. [Custom packages](https://pythoninchemistry.org/intro_python_chemists/advanced/custom_packages.html) + +## On coding style + +In this book we prioritise readibility and understandability of code over everything else. +Therefore, the code herein will **not** necessarily adhere to PEP8 or any other standard, in particular if it sacrifices the educational utility of the material. +**All** issues opened that are based purely on standard adherence **will** be closed without considering. +However, we are open to issues and pull requests that discuss/improve coding style **if** the focus is on making the code clearer for the learner. + ## Referencing Should you wish to refer to this work elsewhere, we mint a DOI for each [release](https://github.com/pythoninchemistry/intro_python_chemists/releases) of the book. From 39a828e38bb38d5ad63ee23d09f5c4f7fb8497aa Mon Sep 17 00:00:00 2001 From: Andrew McCluskey Date: Mon, 23 Mar 2020 15:11:50 +0000 Subject: [PATCH 2/2] remove style from intro ; --- content/intro.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/content/intro.md b/content/intro.md index eaaf326..215f18f 100644 --- a/content/intro.md +++ b/content/intro.md @@ -33,14 +33,6 @@ If you would like to be involved, please look at the [contributing guidelines](h 2. [Classes](https://pythoninchemistry.org/intro_python_chemists/advanced/classes.html) 3. [Custom packages](https://pythoninchemistry.org/intro_python_chemists/advanced/custom_packages.html) - -## On coding style - -In this book we prioritise readibility and understandability of code over everything else. -Therefore, the code herein will **not** necessarily adhere to PEP8 or any other standard, in particular if it sacrifices the educational utility of the material. -**All** issues opened that are based purely on standard adherence **will** be closed without considering. -However, we are open to issues and pull requests that discuss/improve coding style **if** the focus is on making the code clearer for the learner. - ## Referencing Should you wish to refer to this work elsewhere, we mint a DOI for each [release](https://github.com/pythoninchemistry/intro_python_chemists/releases) of the book.