From 7ac9ac5299164181b8057f7edf20672a2c37cdb2 Mon Sep 17 00:00:00 2001 From: Lars Trieloff <trieloff@adobe.com> Date: Thu, 12 Apr 2018 12:53:21 +0000 Subject: [PATCH] Fixes #46 for property descriptions --- examples/docs/deepextending.schema.md | 4 ++-- examples/docs/definitions.schema.md | 2 +- examples/docs/extending.schema.md | 4 ++-- examples/docs/simpletypes.schema.md | 6 +++--- spec/examples/deepextending.schema.md | 4 ++-- spec/examples/definitions.schema.md | 2 +- spec/examples/extending.schema.md | 4 ++-- spec/examples/simpletypes.schema.md | 6 +++--- templates/md/array-type.ejs | 2 +- templates/md/nested-property.ejs | 2 +- templates/md/pattern-property.ejs | 2 +- templates/md/property.ejs | 2 +- 12 files changed, 20 insertions(+), 20 deletions(-) diff --git a/examples/docs/deepextending.schema.md b/examples/docs/deepextending.schema.md index ccb5ed6..ff1808d 100644 --- a/examples/docs/deepextending.schema.md +++ b/examples/docs/deepextending.schema.md @@ -36,7 +36,7 @@ This is an extending schema. It is extending another extending schema. It pulls ## @id -An `id` with an `@` in front of it. The `@` stands for "dot com" +An `id` with an `@` in front of it. The `@` stands for "dot com" `@id` * is optional @@ -87,7 +87,7 @@ A horse walks into it. ## baz ### BAAAZ! -This property has a unique name to demonstrate it's uniqueness. +This property has a unique name to demonstrate it's uniqueness. `baz` * is optional diff --git a/examples/docs/definitions.schema.md b/examples/docs/definitions.schema.md index 9902fdc..b2a4e3c 100644 --- a/examples/docs/definitions.schema.md +++ b/examples/docs/definitions.schema.md @@ -43,7 +43,7 @@ aks. ## @id -An `id` with an `@` in front of it. The `@` stands for "dot com" +An `id` with an `@` in front of it. The `@` stands for "dot com" `@id` * is optional diff --git a/examples/docs/extending.schema.md b/examples/docs/extending.schema.md index e952bee..49f40be 100644 --- a/examples/docs/extending.schema.md +++ b/examples/docs/extending.schema.md @@ -34,7 +34,7 @@ This is an extending schema. It pulls `definitions` from other schemas. ## @id -An `id` with an `@` in front of it. The `@` stands for "dot com" +An `id` with an `@` in front of it. The `@` stands for "dot com" `@id` * is optional @@ -85,7 +85,7 @@ A horse walks into it. ## baz ### BAAAZ! -This property has a unique name to demonstrate it's uniqueness. +This property has a unique name to demonstrate it's uniqueness. `baz` * is optional diff --git a/examples/docs/simpletypes.schema.md b/examples/docs/simpletypes.schema.md index 945c245..c641b0d 100644 --- a/examples/docs/simpletypes.schema.md +++ b/examples/docs/simpletypes.schema.md @@ -61,7 +61,7 @@ Guess what number is valid ## interger_constrained -Just a whole number. I don't like fractions. Don't get too small +Just a whole number. I don't like fractions. Don't get too small `interger_constrained` * is optional @@ -81,7 +81,7 @@ Just a whole number. I don't like fractions. Don't get too small ## interger_unconstrained -Just a whole number. I don't like fractions. +Just a whole number. I don't like fractions. `interger_unconstrained` * is optional @@ -100,7 +100,7 @@ Just a whole number. I don't like fractions. ## number_constrained -Just a number. Don't get too big. +Just a number. Don't get too big. `number_constrained` * is optional diff --git a/spec/examples/deepextending.schema.md b/spec/examples/deepextending.schema.md index ccb5ed6..ff1808d 100644 --- a/spec/examples/deepextending.schema.md +++ b/spec/examples/deepextending.schema.md @@ -36,7 +36,7 @@ This is an extending schema. It is extending another extending schema. It pulls ## @id -An `id` with an `@` in front of it. The `@` stands for "dot com" +An `id` with an `@` in front of it. The `@` stands for "dot com" `@id` * is optional @@ -87,7 +87,7 @@ A horse walks into it. ## baz ### BAAAZ! -This property has a unique name to demonstrate it's uniqueness. +This property has a unique name to demonstrate it's uniqueness. `baz` * is optional diff --git a/spec/examples/definitions.schema.md b/spec/examples/definitions.schema.md index 9902fdc..b2a4e3c 100644 --- a/spec/examples/definitions.schema.md +++ b/spec/examples/definitions.schema.md @@ -43,7 +43,7 @@ aks. ## @id -An `id` with an `@` in front of it. The `@` stands for "dot com" +An `id` with an `@` in front of it. The `@` stands for "dot com" `@id` * is optional diff --git a/spec/examples/extending.schema.md b/spec/examples/extending.schema.md index e952bee..49f40be 100644 --- a/spec/examples/extending.schema.md +++ b/spec/examples/extending.schema.md @@ -34,7 +34,7 @@ This is an extending schema. It pulls `definitions` from other schemas. ## @id -An `id` with an `@` in front of it. The `@` stands for "dot com" +An `id` with an `@` in front of it. The `@` stands for "dot com" `@id` * is optional @@ -85,7 +85,7 @@ A horse walks into it. ## baz ### BAAAZ! -This property has a unique name to demonstrate it's uniqueness. +This property has a unique name to demonstrate it's uniqueness. `baz` * is optional diff --git a/spec/examples/simpletypes.schema.md b/spec/examples/simpletypes.schema.md index 945c245..c641b0d 100644 --- a/spec/examples/simpletypes.schema.md +++ b/spec/examples/simpletypes.schema.md @@ -61,7 +61,7 @@ Guess what number is valid ## interger_constrained -Just a whole number. I don't like fractions. Don't get too small +Just a whole number. I don't like fractions. Don't get too small `interger_constrained` * is optional @@ -81,7 +81,7 @@ Just a whole number. I don't like fractions. Don't get too small ## interger_unconstrained -Just a whole number. I don't like fractions. +Just a whole number. I don't like fractions. `interger_unconstrained` * is optional @@ -100,7 +100,7 @@ Just a whole number. I don't like fractions. ## number_constrained -Just a number. Don't get too big. +Just a number. Don't get too big. `number_constrained` * is optional diff --git a/templates/md/array-type.ejs b/templates/md/array-type.ejs index e6237c2..ad9c13f 100644 --- a/templates/md/array-type.ejs +++ b/templates/md/array-type.ejs @@ -36,7 +36,7 @@ Unknown type `<%= schema.items.type %>`. <% if (schema.items.description!==undefined) { %> -<%= (""+schema.items.description).replace(/\n/g, '\n\n') %> +<%- (""+schema.items.description).replace(/\n/g, '\n\n') %> <% } %> diff --git a/templates/md/nested-property.ejs b/templates/md/nested-property.ejs index 0a3f843..11b6222 100644 --- a/templates/md/nested-property.ejs +++ b/templates/md/nested-property.ejs @@ -9,7 +9,7 @@ <% if (schema.title) { %>##### <%= schema.title %><% } %> -<%= (""+schema.description).replace(/\n/g, '\n\n') %> +<%- (""+schema.description).replace(/\n/g, '\n\n') %> `<%=name %>` diff --git a/templates/md/pattern-property.ejs b/templates/md/pattern-property.ejs index 6c84cf3..5af5155 100644 --- a/templates/md/pattern-property.ejs +++ b/templates/md/pattern-property.ejs @@ -12,7 +12,7 @@ Applies to all properties that match the regular expression `<%=name %>` <% if (schema.title) { %>### <%= schema.title %><% } %> <% if (schema.description) { %> -<%= schema.description.replace(/\n/g, '\n\n') %> +<%- schema.description.replace(/\n/g, '\n\n') %> <% } %> `<%=name %>` diff --git a/templates/md/property.ejs b/templates/md/property.ejs index 522c68f..b4edeb2 100644 --- a/templates/md/property.ejs +++ b/templates/md/property.ejs @@ -9,7 +9,7 @@ <% if (schema.title) { %>### <%= schema.title %><% } %> <% if (schema.description) { %> -<%= schema.description.replace(/\n/g, '\n\n') %> +<%- schema.description.replace(/\n/g, '\n\n') %> <% } %> `<%=name %>` -- GitLab