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

Improve star catalog documentation #3976

Merged
merged 4 commits into from
Nov 18, 2024
Merged

Conversation

henrysky
Copy link
Contributor

Description

I have improved the readability of Star1 structure by put meaningful variable name in Star1 cpp code as well as fixing number error in the star catalog appendix.

The motivation of this PR is I am experimenting and looking into possible ways to improve star catlogs in Stellarium and want to make little changes without any breaking/new features first.

Fixes # (issue)

N/A

Screenshots (if appropriate):

N/A

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • This change requires a documentation update
  • Housekeeping

How Has This Been Tested?

I Don't expect there will be any breaking changes nor introduce any new feartures.

Test Configuration:

  • Operating system: <Name, version number>
  • Graphics Card: <Manufacturer (likely Intel, NVidia, AMD?), Model (HD, Geforce, Radeon..., with model number), driver version?>

N/A

Checklist:

  • My code follows the code style of this project.
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (header file)
  • I have updated the respective chapter in the Stellarium User Guide
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Copy link

Great PR! Please pay attention to the following items before merging:

Files matching guide/**:

  • Did you remember to update screenshots to match new updates?
  • Did you remember to grammar check in changed part of documentation?

This is an automatically generated QA checklist based on modified files.

@alex-w
Copy link
Member

alex-w commented Nov 16, 2024

Did you tested the code on big-endian and little-endian systems?

@henrysky
Copy link
Contributor Author

Only tested on little-endian. Unfortunately I do not have any big-endian computer :(

Copy link
Contributor

@10110111 10110111 left a comment

Choose a reason for hiding this comment

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

The changes to the struct make sense to me. I don't think there's any endianness-related problem to be expected, since all that's changed there is the names of the same-sized objects as before.

src/core/modules/Star.hpp Show resolved Hide resolved
guide/app_star_catalogue.tex Show resolved Hide resolved
src/core/modules/Star.hpp Outdated Show resolved Hide resolved
@alex-w alex-w added this to the 24.4 milestone Nov 18, 2024
Copy link
Member

@alex-w alex-w left a comment

Choose a reason for hiding this comment

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

Thanks!

@10110111 please merge the PR

@10110111 10110111 merged commit 1b2f617 into Stellarium:master Nov 18, 2024
14 checks passed
@henrysky henrysky deleted the star_catalog branch November 18, 2024 19:33
@henrysky henrysky restored the star_catalog branch November 18, 2024 19:33
@henrysky henrysky deleted the star_catalog branch November 18, 2024 19:35
@alex-w alex-w added the state: published The fix has been published for testing in weekly binary package label Dec 9, 2024
Copy link

github-actions bot commented Dec 9, 2024

Hello @henrysky!

Please check the fresh version (development snapshot) of Stellarium:
https://github.com/Stellarium/stellarium-data/releases/tag/weekly-snapshot

@alex-w alex-w removed the state: published The fix has been published for testing in weekly binary package label Dec 22, 2024
Copy link

Hello @henrysky!

Please check the latest stable version of Stellarium:
https://github.com/Stellarium/stellarium/releases/latest

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants