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

Autolev Parser Documentation #15046

Merged
merged 3 commits into from Aug 10, 2018

Conversation

Projects
None yet
4 participants
@NikhilPappu
Copy link
Contributor

NikhilPappu commented Aug 6, 2018

  • other
    • Added documentation for the Autolev Parser under Mechanics. Added the Introduction and Usage sections.
@sympy-bot

This comment has been minimized.

Copy link

sympy-bot commented Aug 6, 2018

Hi, I am the SymPy bot (v125). I'm here to make sure this pull request has a release notes entry. Please read the guide on how to write release notes.

Click here to see the pull request description that was parsed.

<!-- BEGIN RELEASE NOTES -->
- other
  - Added documentation for the Autolev Parser under Mechanics. Added the Introduction and Usage sections.
<!-- END RELEASE NOTES -->

Your release notes are in good order.

Here is what the release notes will look like:

  • other
    • Added documentation for the Autolev Parser under Mechanics. Added the Introduction and Usage sections. (#15046 by @NikhilPappu)

This will be added to https://github.com/sympy/sympy/wiki/Release-Notes-for-1.2.1.

Note: This comment will be updated with the latest check if you edit the pull request. You need to reload the page to see it.

Update

The release notes on the wiki have been updated.

@NikhilPappu

This comment has been minimized.

Copy link
Contributor Author

NikhilPappu commented Aug 6, 2018

@certik
I have yet to write the Gotchas section properly and I have to write the Issues section as well.
After this I shall include an updated version of the PyDy for Autolev Users guide that I had previously written.
I should be done with this by the 9th. I shall then finish the output tests from the 10th-12th after which I shall submit the final report.

@certik

This comment has been minimized.

Copy link
Member

certik commented Aug 6, 2018

@NikhilPappu thanks. That sounds like a good plan. cc @moorepants.

@NikhilPappu

This comment has been minimized.

Copy link
Contributor Author

NikhilPappu commented Aug 7, 2018

@certik @moorepants
I have finished the gotchas section. Now I have to write the issues section and revamp the PyDy for Autolev Users guide.

@moorepants

This comment has been minimized.

Copy link
Member

moorepants commented Aug 7, 2018

@NikhilPappu Please break these items up into separate PRs. It makes it much easier to review and get merged. For example, each major section of your documentation could be a separate PR.

@NikhilPappu NikhilPappu force-pushed the NikhilPappu:autolev_parser_docs branch from 19374aa to eea409d Aug 8, 2018

@NikhilPappu NikhilPappu changed the title Added documentation for Autolev Parser under Mechanics Autolev Parser Documentation PR 1 Aug 8, 2018

@NikhilPappu NikhilPappu force-pushed the NikhilPappu:autolev_parser_docs branch 2 times, most recently from c310057 to e333bb5 Aug 8, 2018

@NikhilPappu NikhilPappu changed the title Autolev Parser Documentation PR 1 Autolev Parser Documentation Aug 8, 2018

@NikhilPappu

This comment has been minimized.

Copy link
Contributor Author

NikhilPappu commented Aug 8, 2018

@moorepants I reduced this PR to the Intro and Usage sections. How should I make a 2nd PR now for adding the Gotchas section? Should I make a PR from a different branch say autolev_parser_docs_2 to this one (autolev_parser_docs) because making a PR from autolev_parser_docs2 to master would include all the changes in the diff.

Added documentation for Autolev Parser under Mechanics
This PR contains the Introduction and Usage sections

@NikhilPappu NikhilPappu force-pushed the NikhilPappu:autolev_parser_docs branch from e333bb5 to 22c3f27 Aug 8, 2018

@moorepants

This comment has been minimized.

Copy link
Member

moorepants commented Aug 8, 2018

You can branch off this one and submit the new PR. We will merge this one first and then the commits will disappear from the second one. As long as there are separate commits for each chunk we can view the separate changes via github.

(Comments ``%`` have been included to show the Autolev responses):
::

# % double_pendulum.al

This comment has been minimized.

@moorepants

moorepants Aug 8, 2018

Member

What are the # for?

This comment has been minimized.

@moorepants

moorepants Aug 8, 2018

Member

I think you should remove the leading hash and make use of the ..code:: directive, you may need to specify a null language to avoid syntax highlighting.

This comment has been minimized.

@NikhilPappu

NikhilPappu Aug 8, 2018

Author Contributor

Yeah that's what I wanted to achieve. I shall make the change and also open the other PRs in a while.

@moorepants
Copy link
Member

moorepants left a comment

This looks good. I have one request to fix and then this can be merged.

(Comments ``%`` have been included to show the Autolev responses):
::

# % double_pendulum.al

This comment has been minimized.

@moorepants

moorepants Aug 8, 2018

Member

I think you should remove the leading hash and make use of the ..code:: directive, you may need to specify a null language to avoid syntax highlighting.

CODE DYNAMICS() some_filename.c
The parser can be used as follows:
::

This comment has been minimized.

@moorepants

moorepants Aug 8, 2018

Member

You can also just do this:

The parser can be used as follows::
@moorepants

This comment has been minimized.

Copy link
Member

moorepants commented Aug 8, 2018

+1 to merge once tests pass.

@NikhilPappu NikhilPappu force-pushed the NikhilPappu:autolev_parser_docs branch from b98a945 to 60f5bb9 Aug 8, 2018

@NikhilPappu

This comment has been minimized.

Copy link
Contributor Author

NikhilPappu commented Aug 8, 2018

@moorepants Can you have a look at these #15013 and #15006 as well?

@moorepants moorepants merged commit d591f6d into sympy:master Aug 10, 2018

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
sympy-bot/release-notes The release notes look OK
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.