Merge pull request #686 from realm/jp-sort-optional-usr

fix crash when sorting declarations with no USR
realm · Nov 26, 2016 · 7e752d1 · 7e752d1
2 parents 2528039 + b634321
commit 7e752d1
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 ## Master
 
+##### Breaking
+
+* None.
+
 ##### Enhancements
 
 * Podspec-based documentation will take trunk's `pushed_with_swift_version`
@@ -18,6 +22,12 @@
 * Rename Dash typedef type from "Alias" to "Type".  
   [Bogdan Popescu](https://github.com/Kapeli)
 
+* Fix crash when sorting multiple identically named declarations with no USR,
+  which is very common when generating docs for podspecs supporting multiple
+  platforms.  
+  [JP Simard](https://github.com/jpsim)
+  [#661](https://github.com/realm/jazzy/issues/661)
+
 ## 0.7.2
 
 ##### Breaking

diff --git a/lib/jazzy/doc_builder.rb b/lib/jazzy/doc_builder.rb
@@ -32,7 +32,7 @@ def self.prepare_output_dir(output_dir, clean)
     def self.doc_structure_for_docs(docs)
       docs.map do |doc|
         children = doc.children
-                      .sort_by { |c| [c.nav_order, c.name, c.usr] }
+                      .sort_by { |c| [c.nav_order, c.name, c.usr || ''] }
                       .flat_map do |child|
           # FIXME: include arbitrarily nested extensible types
           [{ name: child.name, url: child.url }] +