From 3365ffe30e7400af73bbf5b45b8d1dfe64246b78 Mon Sep 17 00:00:00 2001 From: "Thomas A. Christensen II" <25492070+MillironX@users.noreply.github.com> Date: Thu, 23 Sep 2021 09:11:47 -0500 Subject: [PATCH] Fix package name --- Project.toml | 2 +- README.md | 2 +- docs/make.jl | 2 +- docs/src/index.md | 4 ++-- src/{cowsay.jl => Cowsay.jl} | 11 ++++++++--- 5 files changed, 13 insertions(+), 8 deletions(-) rename src/{cowsay.jl => Cowsay.jl} (88%) diff --git a/Project.toml b/Project.toml index 3c0cac9..6369a05 100644 --- a/Project.toml +++ b/Project.toml @@ -1,4 +1,4 @@ -name = "cowsay" +name = "Cowsay" uuid = "b6370f49-8ad1-4651-ad9e-3639b35da0e9" authors = ["Thomas A. Christensen II <25492070+MillironX@users.noreply.github.com> and contributors"] version = "0.1.0" diff --git a/README.md b/README.md index 3e7f5b6..f6b17c0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# cowsay +# Cowsay.jl [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://MillironX.github.io/cowsay.jl/stable) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://MillironX.github.io/cowsay.jl/dev) diff --git a/docs/make.jl b/docs/make.jl index f641bda..391eb47 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -4,7 +4,7 @@ using Documenter DocMeta.setdocmeta!(cowsay, :DocTestSetup, :(using cowsay); recursive=true) makedocs(; - modules=[cowsay], + modules=[Cowsay], authors="Thomas A. Christensen II <25492070+MillironX@users.noreply.github.com> and contributors", repo="https://github.com/MillironX/cowsay.jl/blob/{commit}{path}#{line}", sitename="cowsay.jl", diff --git a/docs/src/index.md b/docs/src/index.md index 632cafa..86d0bdc 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,5 +1,5 @@ ```@meta -CurrentModule = cowsay +CurrentModule = Cowsay ``` # cowsay @@ -10,5 +10,5 @@ Documentation for [cowsay](https://github.com/MillironX/cowsay.jl). ``` ```@autodocs -Modules = [cowsay] +Modules = [Cowsay] ``` diff --git a/src/cowsay.jl b/src/Cowsay.jl similarity index 88% rename from src/cowsay.jl rename to src/Cowsay.jl index dad7a00..9a74e56 100644 --- a/src/cowsay.jl +++ b/src/Cowsay.jl @@ -1,8 +1,13 @@ -module cowsay +module Cowsay -export cowsay_function +export cowsay -function cowsay_function(message::AbstractString) +""" + cowsay(message::AbstractString) + +Prints a cow saying `message` as unwrapped text. +""" +function cowsay(message::AbstractString) messagelines = split(message, "\n") nlines = length(messagelines)