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

Add list of parameters for the acados matlab interface #470

Open
wants to merge 1 commit into
base: master
from

Conversation

@EnricaSo
Copy link
Contributor

commented Sep 13, 2019

The added table contains the list of parameters with the following columns: parameter name, description, accepted values and other info such as relevant references. It is not exhaustive yet.

The best workflow to generate the table that I found for now is the following:

  1. edit the shared file: https://docs.google.com/document/d/14lLBsLHhSodpI9Lhq3YMoge5dXzUjT22pmzlMGeta50/edit?usp=sharing
  2. download in .docx and convert to Github-flavored markdown with pandoc
  3. copy-paste to "index.md"
    Any different proposal is well accepted.
The added table contains the list of parameters with the following columns: parameter name, description, accepted values and other info such as relevant references. It is not exhaustive yet.

The best workflow to generate the table that I found for now is the following:
1) edit the shared file: https://docs.google.com/document/d/14lLBsLHhSodpI9Lhq3YMoge5dXzUjT22pmzlMGeta50/edit?usp=sharing
2) download in .docx and convert to Github-flavored markdown with pandoc
3) copy-paste to "index.md"
Any different proposal is well accepted.
@codecov

This comment has been minimized.

Copy link

commented Sep 13, 2019

Codecov Report

Merging #470 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #470   +/-   ##
=======================================
  Coverage   67.55%   67.55%           
=======================================
  Files          45       45           
  Lines       10581    10581           
=======================================
  Hits         7148     7148           
  Misses       3433     3433
1 similar comment
@codecov

This comment has been minimized.

Copy link

commented Sep 13, 2019

Codecov Report

Merging #470 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #470   +/-   ##
=======================================
  Coverage   67.55%   67.55%           
=======================================
  Files          45       45           
  Lines       10581    10581           
=======================================
  Hits         7148     7148           
  Misses       3433     3433
@giaf

This comment has been minimized.

Copy link
Collaborator

commented Oct 2, 2019

@tmmsartor any progress with this PR?

@EnricaSo

This comment has been minimized.

Copy link
Contributor Author

commented Oct 2, 2019

I have edited the Google doc few days ago. The references and descriptions are not complete yet, but the list of parameters should be exhaustive now. Let me know if/how I can help on this.
Cheers,
Enrica

@tmmsartor tmmsartor referenced this pull request Oct 4, 2019
@tmmsartor

This comment has been minimized.

Copy link
Member

commented Oct 4, 2019

Hi @EnricaSo , sorry for late answer, I was trying to integrate the generated html in our read the docs based web site, but it was not looking to readable, I think the best option is to keep this "docs" in the form of an spreadsheet for now, see #486. (It is maybe not in sync with the doc version of it)
If you want to give edit access to it to other people just ask 👐

@EnricaSo

This comment has been minimized.

Copy link
Contributor Author

commented Oct 4, 2019

Thank you @tmmsartor for adding the cheatsheet and the doc, it's very practical!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.