Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stub out XML parsing #22

Merged
merged 3 commits into from
Aug 19, 2015
Merged

Stub out XML parsing #22

merged 3 commits into from
Aug 19, 2015

Conversation

ericholscher
Copy link
Member

Adds XML doc comment parsing on description, parameter, and return fields. It handles the following tags:

  • see and seealso - replaces with a reference link
  • paramref and typeparamref - just replaces with bold text as we can't reference parameters

ericholscher and others added 2 commits August 18, 2015 12:22
… patterns

Relies on regex replace and multiple replacement substitions, rather than
iterating over the pattern and applying logic to the found patterns.

Handles:

 * see & seealso - creates a reference link
 * paramref & typepararef - we can't reference params in sphinx, so this just
   replaces with bold text
@agjohnson
Copy link
Contributor

Failing tests are a symptom of the failing slugging, fixed in #23

@agjohnson agjohnson added needs: feedback Needed: Reproduction Case This issue needs a small test case to reproduce the issue before it can be worked on and removed needs: feedback labels Aug 19, 2015
ericholscher added a commit that referenced this pull request Aug 19, 2015
@ericholscher ericholscher merged commit 82470be into master Aug 19, 2015
@AWhetter AWhetter deleted the xml-parsing branch August 7, 2018 21:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: Reproduction Case This issue needs a small test case to reproduce the issue before it can be worked on
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants