Improved Contrast for Function Signatures in Documentation in Dark Theme

[DineshNehra29]

Fixes #456

Description:
This PR enhances the readability of function signatures in the PyOpenMS documentation in dark theme by increasing the contrast of italicized parameters and type hints. The previous color scheme caused issues where parameters like self, key, and desc blended into the dark background, making them difficult to read.

Current behavior:

After Changes:

Summary by CodeRabbit

• Style
  • Refined the appearance of parameter names in function signatures by updating their color to a brighter blue for improved clarity and consistency.

This update enhances the visual presentation without any other changes to overall styling or functionality.

[coderabbitai]

Walkthrough

The change updates the CSS styling for parameter names in function signatures. Specifically, the color property is modified from #16324F to #3f87d3, while the rest of the CSS remains unchanged.

Changes

File	Change Summary
docs/.../custom.css	Updated the color value for parameter names in function signatures from #16324F to #3f87d3.

Poem

I'm a hopping little rabbit,
Skipping through codes so bright;
A dash of blue now colors a line,
Making parameters shine just right.
With every update, I bounce in delight!
🐰✨

---

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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 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.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/source/_static/custom.css (1)

71-74: Enhanced Parameter Name Contrast
The parameter styling for function signatures has been updated with color: #3f87d3 which should improve readability against dark backgrounds. Please ensure that this new color meets the WCAG contrast ratio guidelines for users with visual impairments.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 521db6c and 8e0b027.

📒 Files selected for processing (1)

• docs/source/_static/custom.css (1 hunks)

[jpfeuffer]

Please show results in light mode, too.

[jpfeuffer]

And please add fixes #issuenumber to your PR text to activate auto close of the associated issue.

[DineshNehra29]

@jpfeuffer I have added light mode screenshots.

[jpfeuffer]

Perfect thanks.