Merge branch 'thebadmonkeydev-add-deprecations-to-connection-fields'

brettchalupa · Mar 4, 2019 · 29c6caa · 29c6caa
2 parents 015e64f + 677e82d
commit 29c6caa
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 21 deletions.
diff --git a/lib/graphql-docs/layouts/includes/connections.html b/lib/graphql-docs/layouts/includes/connections.html
@@ -4,8 +4,11 @@
   <span id="<%= slugify.(connection[:name]) %>" class="field-name connection-name anchored"><%= connection[:name] %> (<code><a href="<%= base_url %>/<%= connection[:type][:path] %>"><%= connection[:type][:info] %></a></code>)</span>
 
   <div class="description-wrapper">
+    <%= include.('deprecations.html', item: connection) %>
+
     <%= include.('notices.html', notices: connection[:notices]) %>
-    <p><%= connection[:description] %></p>
+
+    <%= markdownify.(connection[:description]) %>
 
     <% unless connection[:arguments].empty? %>
       <%= include.('arguments.html', arguments: connection[:arguments]) %>

diff --git a/lib/graphql-docs/layouts/includes/deprecations.html b/lib/graphql-docs/layouts/includes/deprecations.html
@@ -0,0 +1,6 @@
+<% if item[:is_deprecated] %>
+<div class="deprecation-notice <%= classes[:deprecation_notice] %>">
+  <span class="deprecation-title">Deprecation notice</span>
+  <%= markdownify.(item[:deprecation_reason]) %>
+</div>
+<% end %>
diff --git a/lib/graphql-docs/layouts/includes/fields.html b/lib/graphql-docs/layouts/includes/fields.html
@@ -4,21 +4,15 @@
   <span id="<%= slugify.(field[:name]) %>" class="field-name anchored"><%= field[:name] %> (<code><a href="<%= base_url %>/<%= field[:type][:path] %>"><%= field[:type][:info] %></a></code>)</span>
 
   <div class="description-wrapper">
-  <% if field[:is_deprecated] %>
-    <div class="deprecation-notice <%= classes[:deprecation_notice] %>">
-      <span class="deprecation-title">Deprecation notice</span>
-      <%= markdownify.(field[:deprecation_reason]) %>
-    </div>
-  <% end %>
+    <%= include.('deprecations.html', item: field) %>
 
-  <%= include.('notices.html', notices: field[:notices]) %>
+    <%= include.('notices.html', notices: field[:notices]) %>
 
-  <%= markdownify.(field[:description]) %>
-
-  <% unless field[:arguments].empty? %>
-    <%= include.('arguments.html', arguments: field[:arguments]) %>
-  <% end %>
+    <%= markdownify.(field[:description]) %>
 
+    <% unless field[:arguments].empty? %>
+      <%= include.('arguments.html', arguments: field[:arguments]) %>
+    <% end %>
   </div>
 </div>
 

diff --git a/lib/graphql-docs/layouts/includes/values.html b/lib/graphql-docs/layouts/includes/values.html
@@ -5,16 +5,11 @@ <h3 id="fields">Values</h3>
   <h4 id="<%= slugify.(value[:name]) %>" class="name anchored"><%= value[:name] %></h4>
 
   <div class="description-wrapper">
-    <%= include.('notices.html', notices: value[:notices]) %>
+    <%= include.('deprecations.html', item: value) %>
 
-    <% if value[:is_deprecated] %>
-      <div class="deprecation-notice <%= classes[:deprecation_notice] %>">
-        <span class="deprecation-title">Deprecation notice</span>
-        <%= markdownify.(value[:deprecation_reason]) %>
-      </div>
-    <% end %>
+    <%= include.('notices.html', notices: value[:notices]) %>
 
-    <p><%= value[:description] %></p>
+    <%= markdownify.(value[:description]) %>
   </div>
 
 <% end %>