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

Improvements to DocTAPE #617

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Conversation

crecine
Copy link
Contributor

@crecine crecine commented Dec 3, 2024

Summary

Added support for objects like the Aircraft and Mission hierarchies
to get_all_keys, get_value, and glue_keys.
Fixed a bug where setting display=False for glue_variable would display
<IPython.core.display.Markdown object> instead of nothing
Added support for including parentheses in the arguments for get_variable_name

Related Issues

  • Resolves #

Backwards incompatibilities

None

New Dependencies

None

Added support for objects like the Aircraft and Mission hierarchies
to get_all_keys, get_value, and glue_keys.
Fixed a bug where setting display=False for glue_variable would display
<IPython.core.display.Markdown object> instead of nothing
Added support for including parentheses in the arguments for get_variable_name
@crecine crecine requested a review from ehariton December 3, 2024 01:43
@@ -89,6 +89,7 @@ def get_previous_line(n=1) -> str:
def get_variable_name(*variables) -> str:
"""
returns the name of the variable passed to the function as a string
# NOTE: You cannot call this function multiple times on one line
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In python 3.11 inspect adds positions as an attribute to FrameInfo that will allow for this

capturing the output of glue without running RichOutput(**kargs).display()
prevents myst from finding the glued variable
@xjjiang
Copy link
Contributor

xjjiang commented Dec 4, 2024

Desired features:

  • check if a blue variable exist;
  • glue a numpy table.

@crecine
Copy link
Contributor Author

crecine commented Dec 4, 2024

  • check if a blue variable exist;

Could you elaborate on that?

  • glue a numpy table.

do you mean a pandas dataframe? or are you asking for a feature that will automatically format a numpy array into a table?

@xjjiang
Copy link
Contributor

xjjiang commented Dec 4, 2024

Could you elaborate on that?

Yes, a pandas table. I have an example here:

https://github.com/xjjiang/om-Aviary/blob/glue_getting_started/aviary/docs/getting_started/onboarding_level2.ipynb

@crecine crecine added this pull request to the merge queue Dec 10, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Dec 10, 2024
@crecine crecine added this pull request to the merge queue Dec 11, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Dec 11, 2024
@crecine crecine added this pull request to the merge queue Dec 11, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants