Documentation cleanup (#8)

insightsengineering · Nov 7, 2023 · aba4ba7 · aba4ba7
1 parent 8fbe074
commit aba4ba7
Show file tree

Hide file tree

Showing 10 changed files with 11 additions and 0 deletions.
diff --git a/cmd/construct_test.go b/cmd/construct_test.go
@@ -13,6 +13,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+
 package cmd
 
 import (

diff --git a/cmd/download.go b/cmd/download.go
@@ -13,6 +13,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+
 package cmd
 
 import (

diff --git a/cmd/download_test.go b/cmd/download_test.go
@@ -13,6 +13,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+
 package cmd
 
 import (

diff --git a/cmd/parse.go b/cmd/parse.go
@@ -13,6 +13,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+
 package cmd
 
 import (

diff --git a/cmd/parse_test.go b/cmd/parse_test.go
@@ -13,6 +13,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+
 package cmd
 
 import (

diff --git a/cmd/renv_test.go b/cmd/renv_test.go
@@ -13,6 +13,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+
 package cmd
 
 import (

diff --git a/cmd/root.go b/cmd/root.go
@@ -13,6 +13,8 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+
+// Package cmd implements the core functionality of locksmith - the renv.lock generator.
 package cmd
 
 import (

diff --git a/cmd/utils.go b/cmd/utils.go
@@ -13,6 +13,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+
 package cmd
 
 import (

diff --git a/cmd/utils_test.go b/cmd/utils_test.go
@@ -13,6 +13,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+
 package cmd
 
 import (

diff --git a/main.go b/main.go
@@ -1,3 +1,4 @@
+// Package main is the main package of locksmith - the renv.lock generator.
 package main
 
 import "github.com/insightsengineering/locksmith/cmd"