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

An incorrect number of ways to interact with PUDL data is mentioned in the data_access.rst documentation file. #3484

Open
yashpandey06 opened this issue Mar 19, 2024 · 1 comment · May be fixed by #3560
Labels
bug Things that are just plain broken.

Comments

@yashpandey06
Copy link

Describe the bug

An incorrect number of ways to interact with PUDL data is mentioned in the data_access.rst documentation file.

Bug Severity

How badly is this bug affecting you?

  • High: This bug is preventing me from using PUDL.
  • Medium: With some effort, I can work around the bug.
  • Low: The bug isn't causing me problems, but something's still wrong here.

To Reproduce

Steps to reproduce the behavior -- ideally including a code snippet that causes the error to appear.
-Go to this page
-Scroll down to heading "How Should You Access PUDL Data?"
-Number of ways mentioned are 4 but in table there are 6 ways listed out .

Expected behavior

The data_access.rst documentation file should be updated to reflect six ways of interacting with PUDL data instead of four, providing users with clarity on the proper methods of interacting with the data.

Software Environment?

  • Operating System. (e.g. MacOS 14.5, Ubuntu 22.04, Windows Subsystem for Linux v2)
  • Python version and distribution (e.g. Anaconda Python 3.10.6)
  • How did you install PUDL?
    • If you installed using git clone what branch are you using (probably main or dev)
    • If you installed using pip, conda or mamba what version did you install?

Additional context

Add any other context about the problem here.

@yashpandey06 yashpandey06 added the bug Things that are just plain broken. label Mar 19, 2024
@yashpandey06
Copy link
Author

I would be happy if i get to work on this !!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Things that are just plain broken.
Projects
Status: New
1 participant