correct api docs with unrendered links (hyperledger-archives#3832)

Signed-off-by: Matthew B White <[email protected]>
rossPy · Apr 13, 2018 · 286a060 · 286a060
1 parent fd86bde
commit 286a060
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/packages/composer-client/lib/businessnetworkconnection.js b/packages/composer-client/lib/businessnetworkconnection.js
@@ -35,7 +35,7 @@ const LOG = Logger.getLog('BusinessNetworkConnection');
 
 /**
  * Use this class to connect to and then interact with a deployed
- * {@link module:composer-common.BusinessNetworkDefinition BusinessNetworkDefinition}.
+ * {@link module:composer-common.BusinessNetworkDefinition Business Network Definition}.
  * Use the AdminConnection class in the composer-admin module to deploy
  * BusinessNetworksDefinitions.
  * @extends EventEmitter
@@ -68,8 +68,8 @@ class BusinessNetworkConnection extends EventEmitter {
     }
 
     /**
-     * Gets the currently connected
-     * {@link module:composer-common.BusinessNetworkDefinition BusinessNetworkDefinition}.
+     * Gets the currently connected business network.
+     * {@link module:composer-common.BusinessNetworkDefinition Business Network Definition}.
      * @example
      * const connection = new BusinessNetworkConnection();
      * const definition = await connection.connect('admin@network-name');

diff --git a/packages/composer-website/jekylldocs/_plugins/link.rb b/packages/composer-website/jekylldocs/_plugins/link.rb
@@ -17,17 +17,17 @@ def rewrite_links(site, page)
       page.content = page.content.gsub(/(\[[^\]]*\]\([^:\)]*)\.md\)/, '\1.html)')
 
       # Special cases to copy with difference approaches to the {@link xxxx} tag      
-      page.content = page.content.gsub(/\{@link (#[\w]*) (\w*)\}/) { "[#{$2}](#{$1.downcase})"  }
+      page.content = page.content.gsub(/\{@link (#[\w]*) ([\w\s]*)\}/) { "[#{$2}](#{$1.downcase})"  }
       page.content = page.content.gsub(/\{@link (#[\w]*)\}/) { "[#{$1}](#{$1.downcase})"  }
-      page.content = page.content.gsub(/\{@link (\w*)[.-]([\w#]*) (\w*)\}/) { "[#{$3}](#{$1}-#{$2.downcase})"  }
+      page.content = page.content.gsub(/\{@link (\w*)[.-]([\w#]*) ([\w\s]*)\}/) { "[#{$3}](#{$1}-#{$2.downcase})"  }
       page.content = page.content.gsub(/\{@link (?:module:)?(?:composer-)?(\w*)[.-]([\w#]*)\}/) { "[#{$2}](#{$1}-#{$2.downcase})"  }
       page.content = page.content.gsub(/\{@link ([\w#]*)(?:\[\])?\}/) { "[#{$1}]("+modulename+"-#{$1.downcase})"  }
-      page.content = page.content.gsub(/\{@link ([\w#]*) (\w*)\}/) { "[#{$2}]("+modulename+"-#{$1.downcase})"  }
+      page.content = page.content.gsub(/\{@link ([\w#]*) ([\w\s]*)\}/) { "[#{$2}]("+modulename+"-#{$1.downcase})"  }
+      page.content = page.content.gsub(/\{(?:@link )?(?:module:)?(?:composer-)?(\w*)[.-]([\w#]*) ([\w\s]*)\}/) { "[#{$3}](#{$1}-#{$2.downcase})"  }
 
 # Candidate extra regexp to cope with more cases of links... not yet fully tested     
-#      page.content = page.content.gsub(/\{(?:@link )?(?:module:)?(?:composer-)?(#[\w]*) (\w*)\}/) { "[#{$2}](#{$1.downcase})"  }
+      # page.content = page.content.gsub(/\{(?:@link )?(?:module:)?(?:composer-)?(#[\w]*) (\w*)\}/) { "[#{$2}](#{$1.downcase})"  }
 #      page.content = page.content.gsub(/\{(?:@link )?(?:module:)?(?:composer-)?(#[\w]*)\}/) { "[#{$1}](#{$1.downcase})"  }
-#      page.content = page.content.gsub(/\{(?:@link )?(?:module:)?(?:composer-)?(\w*)[.-]([\w#]*) (\w*)\}/) { "[#{$3}](#{$1}-#{$2.downcase})"  }
 #      page.content = page.content.gsub(/\{(?:@link )?(?:module:)?(?:composer-)?(\w*)[.-]([\w#]*)\}/) { "[#{$2}](#{$1}-#{$2.downcase})"  }
 #      page.content = page.content.gsub(/\{(?:@link )?(?:module:)?(?:composer-)?([\w#]*)\}/) { "[#{$1}]("+modulename+"-#{$1.downcase})"  }
 #      page.content = page.content.gsub(/\{(?:@link )?(?:module:)?(?:composer-)?([\w#]*) (\w*)\}/) { "[#{$2}]("+modulename+"-#{$1.downcase})"  }