Skip to content

Commit

Permalink
Fix spacing of information in docs file
Browse files Browse the repository at this point in the history
  • Loading branch information
@NoComment1105
NoComment1105 committed Feb 26, 2024
1 parent afb1de3 commit e74082e
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 20 deletions.
3 changes: 1 addition & 2 deletions build.gradle.kts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import org.jetbrains.kotlin.gradle.dsl.KotlinVersion
import org.jetbrains.kotlin.gradle.tasks.KotlinCompile

object Meta {
const val PROJECT_VERSION = "0.1.4"
const val PROJECT_VERSION = "0.1.5"
const val DESCRIPTION = "Generate documentation for KordEx bots!"
const val GITHUB_REPO = "HyacinthBots/doc-generator"
const val RELEASE = "https://s01.oss.sonatype.org/content/repositories/releases/"
Expand All @@ -27,7 +27,6 @@ object Meta {
private val isUndefined: Boolean get() = version == "undefined"
}

@Suppress("DSL_SCOPE_VIOLATION")
plugins {
`java-library`
`maven-publish`
Expand Down
36 changes: 18 additions & 18 deletions src/main/kotlin/org/hyacinthbots/docgenerator/generator/DocsGenerator.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ internal object DocsGenerator {
}

// Add the title and description of the sub command
commandInfo += "#### ${
commandInfo += "### ${
"header.command.name".translate(subProvider, language)
}: `${subCommand.parentCommand?.name?.translate(subProvider, language, bundle)} ${
subCommand.name.translate(subProvider, language, bundle)
Expand All @@ -97,7 +97,7 @@ internal object DocsGenerator {
}\n${
// Add the result of the command, if one was provided
if (subExtraDocs?.commandResult != null) {
"**${"header.result".translate(subProvider, language)}**:${
"\n**${"header.result".translate(subProvider, language)}**: ${
subExtraDocs.commandResult!!.translate(subProvider, language, bundle)
}\n"
} else {
Expand All @@ -106,7 +106,7 @@ internal object DocsGenerator {
}${
// Add the additional info, if there was any provided
if (subExtraDocs?.extraInformation != null) {
"**${"header.additionalinfo".translate(subProvider, language)}**:${
"\n**${"header.additionalinfo".translate(subProvider, language)}**: ${
subExtraDocs.extraInformation!!.translate(subProvider, language, bundle)
}\n"
} else {
Expand All @@ -115,7 +115,7 @@ internal object DocsGenerator {
}${
// Add any required bot perms to the document
if (subCommand.requiredPerms.isNotEmpty()) {
"${"header.permissions.bot".translate(subProvider, language)}:${
"\n**${"header.permissions.bot".translate(subProvider, language)}**:${
subCommand.requiredPerms.formatPermissionsSet(language)
}\n"
} else {
Expand All @@ -124,7 +124,7 @@ internal object DocsGenerator {
}${
// Add any required member perms to the document
if (subCommand.defaultMemberPermissions != null) {
"${"header.permissions.member".translate(subProvider, language)}: ${
"\n**${"header.permissions.member".translate(subProvider, language)}**: ${
subCommand.defaultMemberPermissions.formatPermissionsSet(language)
}\n"
} else {
Expand All @@ -149,12 +149,12 @@ internal object DocsGenerator {
commandInfo +=
"### ${"header.command.name".translate(slashProvider, language)}: `${
slashCommand.name.translate(slashProvider, language, bundle)
}`\n${"header.command.description".translate(slashProvider, language)}: ${
}`\n**${"header.command.description".translate(slashProvider, language)}**: ${
slashCommand.description.translate(slashProvider, language, bundle)
}\n${
// Add the result of the command if there is one
if (extraDocs?.commandResult != null) {
"**${"header.result".translate(slashProvider, language)}**:${
"\n**${"header.result".translate(slashProvider, language)}**: ${
extraDocs.commandResult!!.translate(slashProvider, language, bundle)
}\n"
} else {
Expand All @@ -163,7 +163,7 @@ internal object DocsGenerator {
}${
// Add the extra information if there is any
if (extraDocs?.extraInformation != null) {
"**${"header.additionalinfo".translate(slashProvider, language)}**:${
"\n**${"header.additionalinfo".translate(slashProvider, language)}**: ${
extraDocs.extraInformation!!.translate(slashProvider, language, bundle)
}\n"
} else {
Expand All @@ -172,7 +172,7 @@ internal object DocsGenerator {
}${
// Add the required bot permissions if there are any
if (slashCommand.requiredPerms.isNotEmpty()) {
"**${"header.permissions.bot".translate(slashProvider, language)}**:${
"\n**${"header.permissions.bot".translate(slashProvider, language)}**:${
slashCommand.requiredPerms.formatPermissionsSet(language)
}\n"
} else {
Expand All @@ -181,7 +181,7 @@ internal object DocsGenerator {
}${
// Add the required member permissions if there are any
if (slashCommand.defaultMemberPermissions != null) {
"**${"header.permissions.member".translate(slashProvider, language)}**: ${
"\n**${"header.permissions.member".translate(slashProvider, language)}**: ${
slashCommand.defaultMemberPermissions.formatPermissionsSet(language)
}\n"
} else {
Expand Down Expand Up @@ -224,7 +224,7 @@ internal object DocsGenerator {
}`\n${
// Add the provided command result, if there is one
if (additionalDocs?.commandResult != null) {
"**${"header.result".translate(provider, language)}**:${
"\n**${"header.result".translate(provider, language)}**: ${
additionalDocs.commandResult!!.translate(provider, language, bundle)
}\n"
} else {
Expand All @@ -233,7 +233,7 @@ internal object DocsGenerator {
}${
// Add the provided extra info if there is any
if (additionalDocs?.extraInformation != null) {
"**${"header.additionalinfo".translate(provider, language)}**:${
"\n**${"header.additionalinfo".translate(provider, language)}**: ${
additionalDocs.extraInformation!!.translate(provider, language, bundle)
}\n"
} else {
Expand All @@ -242,7 +242,7 @@ internal object DocsGenerator {
}${
// Add the required bot perms, if there are any
if (messageCommand.requiredPerms.isNotEmpty()) {
"**${"header.permissions.bot".translate(provider, language)}**:${
"\n**${"header.permissions.bot".translate(provider, language)}**:${
messageCommand.requiredPerms.formatPermissionsSet(language)
}\n"
} else {
Expand All @@ -251,7 +251,7 @@ internal object DocsGenerator {
}${
// Add the required member permissions, if there are any
if (messageCommand.defaultMemberPermissions != null) {
"**${"header.permissions.member".translate(provider, language)}**: ${
"\n**${"header.permissions.member".translate(provider, language)}**: ${
messageCommand.defaultMemberPermissions.formatPermissionsSet(language)
}\n"
} else {
Expand Down Expand Up @@ -290,7 +290,7 @@ internal object DocsGenerator {
}\n${
// Add the command result if there is any
if (additionalDocs?.commandResult != null) {
"**${"header.result".translate(provider, language)}**:${
"\n**${"header.result".translate(provider, language)}**: ${
additionalDocs.commandResult!!.translate(provider, language, bundle)
}\n"
} else {
Expand All @@ -299,7 +299,7 @@ internal object DocsGenerator {
}${
// Add the extra information if there is any
if (additionalDocs?.extraInformation != null) {
"**${"header.additionalinfo".translate(provider, language)}**:${
"\n**${"header.additionalinfo".translate(provider, language)}**: ${
additionalDocs.extraInformation!!.translate(provider, language, bundle)
}\n"
} else {
Expand All @@ -308,7 +308,7 @@ internal object DocsGenerator {
}${
// Add the required bot permissions if any
if (userCommand.requiredPerms.isNotEmpty()) {
"**${"header.permissions.bot".translate(provider, language)}**:${
"\n**${"header.permissions.bot".translate(provider, language)}**:${
userCommand.requiredPerms.formatPermissionsSet(language)
}\n"
} else {
Expand All @@ -317,7 +317,7 @@ internal object DocsGenerator {
}${
// Add the required member permissions if any
if (userCommand.defaultMemberPermissions != null) {
"**${"header.permissions.member".translate(provider, language)}**: ${
"\n**${"header.permissions.member".translate(provider, language)}**: ${
userCommand.defaultMemberPermissions.formatPermissionsSet(language)
}\n"
} else {
Expand Down

0 comments on commit e74082e

Please sign in to comment.