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

158 fix documentation container #159

Merged
merged 33 commits into from
Feb 1, 2024
Merged

Conversation

ywkim312
Copy link
Member

@ywkim312 ywkim312 commented Jan 30, 2024

It has been deployed to dev instance. https://incore-dev.ncsa.illinois.edu/doc/pyincore_viz/modules.html
When you access above url, you have to see all the components has the methods

@ywkim312 ywkim312 linked an issue Jan 30, 2024 that may be closed by this pull request
@ywkim312 ywkim312 marked this pull request as ready for review January 31, 2024 19:43
@ywkim312 ywkim312 self-assigned this Jan 31, 2024
@ywkim312 ywkim312 linked an issue Jan 31, 2024 that may be closed by this pull request
Copy link
Contributor

@ylyangtw ylyangtw left a comment

Choose a reason for hiding this comment

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

Looks good. Maybe can remove pytest<8

from base64 import b64encode
from io import BytesIO
from pyincore_viz.plotutil import PlotUtil
from pyincore_viz.tabledatasetlistmap import TableDatasetListMap as table_list_map
from pyincore_viz.tabledatasetlistmap import TableDatasetListMap as tableListMap
Copy link
Member

Choose a reason for hiding this comment

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

any reason you switch to camel case? I think python convention is using underscore.

Copy link
Member

Choose a reason for hiding this comment

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

actually i'm wondering why any of the change is needed in this file. Isn't Sphinx just parsing the docstrings?

Copy link
Member Author

Choose a reason for hiding this comment

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

no this is what sphinx doc said. In fact, it worked in both way. Sphinx is not only parsing docstrings, unfortunately....

Copy link
Member

Choose a reason for hiding this comment

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

really? but we use underscores everywhere :-(

Copy link
Member Author

@ywkim312 ywkim312 Feb 1, 2024

Choose a reason for hiding this comment

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

yes so both cases work like, I mentioned above. Do you want to change to undersocre? then I will change.

Copy link
Member

Choose a reason for hiding this comment

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

yes could you change to underscore if possible? thanks!

Copy link
Member Author

Choose a reason for hiding this comment

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

changed

@ywkim312
Copy link
Member Author

ywkim312 commented Feb 1, 2024

Looks good. Maybe can remove pytest<8

removed

@ywkim312 ywkim312 merged commit 296de43 into develop Feb 1, 2024
8 checks passed
@ywkim312 ywkim312 deleted the 158-fix-documentation-container branch February 1, 2024 17:55
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.

Fix pytest Fix documentation container
3 participants