From 69c4e7537f86c0e01127bdb69ec7bdece53cb838 Mon Sep 17 00:00:00 2001 From: Humble Chirammal Date: Tue, 4 Jun 2019 11:47:45 +0530 Subject: [PATCH] Update coding.md Signed-off-by: Humble Chirammal --- README.md | 2 +- docs/coding.md | 4 ---- 2 files changed, 1 insertion(+), 5 deletions(-) diff --git a/README.md b/README.md index 57881c9a9..6addedeb0 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Card](https://goreportcard.com/badge/github.com/ceph/ceph-csi)](https://goreport [![Build Status](https://travis-ci.org/ceph/ceph-csi.svg?branch=master)](https://travis-ci.org/ceph/ceph-csi) -This repo containes [Container Storage Interface(CSI)] +This repo contains [Container Storage Interface(CSI)] () driver, provisioner, and attacher for Ceph RBD and CephFS. diff --git a/docs/coding.md b/docs/coding.md index f042dd9a8..179fcfb4e 100644 --- a/docs/coding.md +++ b/docs/coding.md @@ -15,8 +15,6 @@ the code and will be pointed out in the review process: * Keep variable names short for variables that are local to the function. * Do not export a function or variable name outside the package until you have an external consumer for it. -* Do not use named return values in function definitions. Use only the type. - Exception: defer()'d functions. ### Imports @@ -60,8 +58,6 @@ import ( ### Logging -* If a function is only invoked as part of a transaction step, always use the - transaction's logger to ensure propagation of request ID and transaction ID. * The inner-most utility functions should never log. Logging must almost always be done by the caller on receiving an `error`. * Always use log level `DEBUG` to provide useful **diagnostic information** to