xy data documentation

[ayushjariyal]

fix #6731

Refactored get_y() and Introduced get_y_arraynames(): Split the functionality of get_y() into two distinct methods:

• get_y(): Returns the Y arrays along with their names and units.
• get_y_arraynames(): Returns only the names of the Y arrays. This improves API clarity and usability.

Update Documentation:

• Added an example usage snippet to the class docstring in XyData for easier understanding.
• Update the index.rst documentation to reflect the new API changes and ensure consistency.

Added Test for get_y_arraynames():

• Introduced a new test case to validate the functionality of get_y_arraynames().

[unkcpz]

Sorry for the late reply. @ayushjariyal could you resolve the conflict and fix the pre-commit error. We'll review it then.

[ayushjariyal]

@unkcpz I accidentally deleted my previous branch and can no longer undo my previous changes, so I have opened a new PR. Could you please review it?

[unkcpz]

Sorry, I think you didn't delete it. It still here https://github.com/ayushjariyal/aiida-core/tree/issue_XyData_documentation

[ayushjariyal]

Oh, I see! Thanks for letting me know. I’ll check on it.

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 78.32%. Comparing base (ce9dcf4) to head (af0bee7). Report is 9 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6736      +/-   ##
==========================================
+ Coverage   78.11%   78.32%   +0.21%     
==========================================
  Files         564      566       +2     
  Lines       42542    42763     +221     
==========================================
+ Hits        33228    33489     +261     
+ Misses       9314     9274      -40     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:

• :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[ayushjariyal]

@unkcpz I am not able to understand why these checks have failed. Can you please help me figure that out?

[unkcpz]

I am not able to understand why these checks have failed. Can you please help me figure that out?

Don't worry, it is auto-fixed by pre-commit action, CI is passed.

[unkcpz]

Thanks for update the PR @ayushjariyal. I am aware of your change, but please don't keep on click the merge with main button, I got notification everytime ;) I'll review it soon, I am quite packed until Thursday.

[ayushjariyal]

Thank you for the update! Apologies for the repeated notifications—I didn’t realize it was causing any inconvenience. I’ll make sure to avoid clicking the merge button going forward. Looking forward to your review whenever you get the time.

[ayushjariyal]

Hey @unkcpz , can you please review my changes.

[ayushjariyal]

@unkcpz , I made changes as per your suggestions. Can you please review them?

[ayushjariyal]

@unkcpz , Can you please review the changes?

[ayushjariyal]

@unkcpz , I have already included the shape of the y data in the data_type.rst file. Could you clarify if any additional changes are needed? I’m not quite sure I fully understand what you want me to do, but I’m happy to make any necessary refinements. Thanks!

[GeigerJ2]

Hi @ayushjariyal, sorry for the delay here. We got quite a few contributions and tasks during that time, so things went on hold for a bit. We are now tying up some loose ends, so I just assigned you and @unkcpz (just for organization), so ideally, we could get this over the finish line soon.