Conversation
tests will fail if the Plot module has undocumented methods or parameters
48 tasks
saving data as CSV and JSON is outside the scope of plotting
Member
Author
|
This PR brought the cookbook forward a long way by adding API information from XML documentation. I can see that the ability to link to a method's URL will be very useful in writing documentation or responding to questions. However, the cookbook generation code and also the XML/Reflection code were thrown together as an experiment. Although they work somewhat, they have large shortcomings and will be hard to maintain as they are now. Since the cookbook/API documentation style has now been mostly figured out, I think these modules should be re-written with this goal in mind. Templating should probably be separated from page generation too. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
#727 was a strong start at automated documentation using XML docs as a source.
This PR relies more heavily on XML documentation and less on reflection.
To achieve this, tests were added to fail if XML documentation is lacking in public Plot or Plottable modules
This PR improves support for auto-properties as well (which Reflection sees as methods).