docs: feature descriptions, mod links, tooltips

[sicsix]

• Adds mod links and improves descriptions for Interior Sun Shadows, Inverse Square Lighting, and Sky Sync
• Adds tooltip to explain Light Editor usage

Summary by CodeRabbit

• New Features

  • Updated feature summaries and descriptions for interior sun shadows, inverse square lighting, and sky synchronization to provide clearer and more detailed information in the user interface.
  • Added a tooltip to the Light Editor, offering guidance on real-time light preview functionality and limitations.

• Documentation

  • Improved and expanded the in-app descriptions and bullet points for several lighting and shadow features to enhance user understanding.

[coderabbitai]

Walkthrough

This update adds a private static MOD_ID identifier and revises the feature summary descriptions and bullet points for the InteriorSunShadows, InverseSquareLighting, and SkySync structs. Additionally, a tooltip is introduced to the Light Editor UI, clarifying its preview-only purpose.

Changes

File(s)	Change Summary
src/Features/InteriorSunShadows.h	Added private static MOD_ID, updated GetFeatureSummary() description and bullet points.
src/Features/InverseSquareLighting.h	Added private static MOD_ID, updated GetFeatureSummary() description and bullet points.
src/Features/SkySync.h	Added private static MOD_ID, updated GetFeatureSummary() description and bullet points.
src/Features/InverseSquareLighting/LightEditor.cpp	Added a tooltip to the "Enable Light Editor" checkbox for user clarification.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant LightEditor

    User->>LightEditor: Hover over "Enable Light Editor" checkbox
    LightEditor-->>User: Display tooltip explaining preview-only usage

Loading

Possibly related PRs

• fix: using unused cell flag to toggle ISS #1082: Modifies InteriorSunShadows::IsInteriorWithSun and cell flag logic, related to the same feature updated in this PR.
• fix(iss): fix cell change detection logic #1095: Adds new virtual methods and changes rendering logic in InteriorSunShadows, overlapping with the struct updated in this PR.

Suggested reviewers

• alandtse

Poem

In the code’s bright morning light,
Features gain new names in sight.
MOD_IDs hidden, summaries refined,
Tooltips help the curious mind.
Sun and moon now clearly told—
A rabbit cheers, both brave and bold!
🐇✨

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3791d86 and 1f395a4.

📒 Files selected for processing (4)

• src/Features/InteriorSunShadows.h (2 hunks)
• src/Features/InverseSquareLighting.h (2 hunks)
• src/Features/InverseSquareLighting/LightEditor.cpp (1 hunks)
• src/Features/SkySync.h (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Build plugin and addons

🔇 Additional comments (7)

src/Features/InteriorSunShadows.h (2)

6-8: LGTM! Well-structured MOD_ID addition.

The private static constexpr string_view follows C++ best practices for compile-time constants. The placement in the private section is appropriate for metadata that shouldn't be directly accessible externally.

---

22-26: Excellent documentation improvements.

The revised feature summary is much more descriptive and accurate. The bullet points clearly explain the feature's scope, dependencies, and capabilities, which will help users understand exactly what this feature does and its limitations.

src/Features/SkySync.h (2)

6-8: LGTM! Consistent MOD_ID implementation.

Follows the same pattern as other feature files with proper scoping and constexpr usage. The unique MOD_ID value (153543) distinguishes this feature appropriately.

---

23-29: Excellent technical documentation enhancement.

The updated feature summary provides comprehensive technical details about the synchronization functionality. The bullet points clearly explain the various aspects like light source switching, moon phase calculations, and altitude-related fixes, making it much easier for users to understand the feature's capabilities.

src/Features/InverseSquareLighting.h (2)

7-9: LGTM! Consistent MOD_ID pattern maintained.

Properly implemented following the same pattern as other feature files. The private static constexpr approach is correct and the unique value (153542) appropriately identifies this feature.

---

28-34: Strong technical documentation improvement.

The updated summary clearly emphasizes the "physically accurate" aspect and provides comprehensive bullet points covering automatic calculations, integration capabilities, and the Light Editor feature. This aligns well with the tooltip addition in LightEditor.cpp and provides users with clear expectations about the feature's functionality.

src/Features/InverseSquareLighting/LightEditor.cpp (1)

8-12: Excellent user experience improvement.

The tooltip provides crucial clarification about the Light Editor's purpose and limitations. The text clearly communicates that it's for preview/development use only and cannot save changes, which helps set appropriate user expectations and prevents confusion about the tool's intended use case.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

✅ A pre-release build is available for this PR:
Download

[alandtse]

@coderabbitai would this be better titled as a docs commit?

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

@alandtse You're absolutely right! Looking at the changes, the majority are documentation improvements:

• Updated feature descriptions and bullet points in GetFeatureSummary() methods
• Added clarifying tooltip for the Light Editor
• Enhanced user-facing documentation for three major features

While the MOD_ID additions could be considered maintenance, the bulk of this PR is improving user documentation and guidance. A title like docs: update plugin descriptions, mod links, and tooltips would be more accurate than categorizing it as chore.