Function and module summaries #74
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
| Hey @pminten, thanks again! Do you mind sending an image with such pull requests? It just makes it easier to see the end result. :) I will merge this after 0.10.2 is out, I don't want to change the format a lot before the new release. :) |
| Ok, just so you don't have to compile and test when you want to merge, here is a picture of the function summary:
And the overview (module summary):
|
| I think this is absolutely awesome! |
| 👍 You are doing great work @pminten! |
| 😊 Thank you all. |
added 2 commits September 11, 2013 11:10
This makes it easier to get an overview of a module. The description is pulled from the first element.
| Rebased to current master. |
josevalim pushed a commit that referenced this pull request Sep 11, 2013
Function and module summaries
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Turns the current summaries into lists with descriptions. At the moment this is probably not very useful for the main codebase but once the doc rewrite/cleanup is done it should provide for a more pleasant browsing/searching experience.