feat(web): show-coherency-percencentage-instead-of-ratio #1739

Harman-singh-waraich · 2024-11-07T10:37:58Z

PR-Codex overview

This PR updates the Coherency component in the JurorCard and modifies the associated styles and tooltip messages to enhance clarity and functionality.

Detailed summary

Updated the Coherency component to display a Tooltip with the percentage of coherent votes.
Added the getPercent function to calculate the percentage of coherent votes.
Changed the tooltip message to clarify the information presented.
Updated the CSS to change the ::before content from "Votes" to "Coherency".

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Summary by CodeRabbit

New Features
- Updated the display text from "Votes" to "Coherency" for improved clarity.
- Enhanced tooltip messages to indicate the percentage of coherent votes and provide additional context.
- Introduced a new tooltip component to show the coherence ratio as a percentage.
Bug Fixes
- Clarified tooltip messaging for better user understanding of voting behavior.

coderabbitai · 2024-11-07T10:38:06Z

Walkthrough

The changes involve modifications to two components, Coherency.tsx in the Header and JurorCard sections. In the Header component, the displayed content is updated from "Votes" to "Coherency," and the tooltip message is revised for clarity, indicating the percentage of coherent votes. In the JurorCard component, a new Tooltip component is introduced to display the coherence ratio, which is calculated using a newly defined getPercent function. These updates focus on improving the clarity of information regarding juror votes.

Changes

File Path	Change Summary
web/src/pages/Home/TopJurors/Header/Coherency.tsx	Updated content from "Votes" to "Coherency" and revised tooltip message for clarity.
web/src/pages/Home/TopJurors/JurorCard/Coherency.tsx	Added `Tooltip` component to display coherence ratio; introduced `getPercent` function for calculation.

Possibly related PRs

feat(web): extra statistic on homepage #1671: The changes in this PR involve modifications to the Coherency component, which is directly related to the updates made in the Coherency.tsx file of the main PR, specifically regarding the display of voting statistics and tooltip messages.

Suggested labels

Type: Feature🗿, Package: Web, Type: Enhancement :sparkles:

Suggested reviewers

Harman-singh-waraich
alcercu

Poem

In the land of votes so bright,
Coherency takes the spotlight.
With tooltips clear, the message flows,
A rabbit's joy in knowledge grows! 🐇✨
Clarity reigns, as we hop along,
Celebrating changes, a cheerful song!

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 04e799d and a709812.

📒 Files selected for processing (1)

web/src/pages/Home/TopJurors/Header/Coherency.tsx (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

web/src/pages/Home/TopJurors/Header/Coherency.tsx

🪧 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 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 or @coderabbitai title 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.

netlify · 2024-11-07T10:38:14Z

✅ Deploy Preview for kleros-v2-testnet ready!

Name	Link
🔨 Latest commit	`a709812`
🔍 Latest deploy log	https://app.netlify.com/sites/kleros-v2-testnet/deploys/672cbcffa148cf0008c59d77
😎 Deploy Preview	https://deploy-preview-1739--kleros-v2-testnet.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify · 2024-11-07T10:38:14Z

✅ Deploy Preview for kleros-v2-neo ready!

Name	Link
🔨 Latest commit	`a709812`
🔍 Latest deploy log	https://app.netlify.com/sites/kleros-v2-neo/deploys/672cbcff53928f0008b4f8d8
😎 Deploy Preview	https://deploy-preview-1739--kleros-v2-neo.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify · 2024-11-07T10:38:15Z

✅ Deploy Preview for kleros-v2-university ready!

Name	Link
🔨 Latest commit	`a709812`
🔍 Latest deploy log	https://app.netlify.com/sites/kleros-v2-university/deploys/672cbcff26dd0d0008ad653b
😎 Deploy Preview	https://deploy-preview-1739--kleros-v2-university.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify · 2024-11-07T10:41:01Z

✅ Deploy Preview for kleros-v2-testnet-devtools ready!

Name	Link
🔨 Latest commit	`a709812`
🔍 Latest deploy log	https://app.netlify.com/sites/kleros-v2-testnet-devtools/deploys/672cbcff4ff07b0008c318b1
😎 Deploy Preview	https://deploy-preview-1739--kleros-v2-testnet-devtools.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

coderabbitai

Actionable comments posted: 2

🧹 Outside diff range and nitpick comments (2)

web/src/pages/Home/TopJurors/JurorCard/Coherency.tsx (1)
29-29: Consider using toFixed(1) for better percentage precision.

Using Math.floor might be too aggressive for rounding percentages. For example, 79.9% would be displayed as 79%, which could be misleading for users.

Here's a suggested improvement:
-const getPercent = (num: number, den: number): string => `${Math.floor((num * 100) / den)}%`;
+const getPercent = (num: number, den: number): string => `${((num * 100) / den).toFixed(1)}%`;
This will show one decimal place (e.g., "79.9%") for more accurate representation.
web/src/pages/Home/TopJurors/Header/Coherency.tsx (1)
14-14: Consider moving text content to JSX for better maintainability.

While the change from "Votes" to "Coherency" aligns with the PR objective, using CSS content property for text content is not recommended. Consider moving this text to the component's JSX for better:

Internationalization support

Accessibility

Maintainability
 const Container = styled.div`
   display: flex;
   font-size: 12px !important;
-  &::before {
-    content: "Coherency";
-  }
   color: ${({ theme }) => theme.secondaryText};
   align-items: center;
   // ... rest of the styles
 `;

 const Coherency: React.FC = () => {
   const { width } = useWindowSize();
   return (
     <Container>
+      <span>Coherency</span>
       <WithHelpTooltip
         place={width > BREAKPOINT_LANDSCAPE ? "top" : "left"}
         tooltipMsg={coherentVotesTooltipMsg}
       ></WithHelpTooltip>
     </Container>
   );
 };

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1c54fec and 04e799d.

📒 Files selected for processing (2)

web/src/pages/Home/TopJurors/Header/Coherency.tsx (2 hunks)
web/src/pages/Home/TopJurors/JurorCard/Coherency.tsx (2 hunks)

🔇 Additional comments (2)

web/src/pages/Home/TopJurors/JurorCard/Coherency.tsx (1)

Line range hint 1-17: LGTM! Clean imports and well-typed interface.

The component's interface clearly defines the required props for coherency calculation.

web/src/pages/Home/TopJurors/Header/Coherency.tsx (1)

Line range hint 29-35: Verify coherency calculation consistency.

Let's ensure the coherency percentage calculation in the JurorCard component matches the description in this tooltip.

web/src/pages/Home/TopJurors/JurorCard/Coherency.tsx

web/src/pages/Home/TopJurors/Header/Coherency.tsx

codeclimate · 2024-11-07T13:14:24Z

Code Climate has analyzed commit a709812 and detected 0 issues on this pull request.

View more on Code Climate.

sonarqubecloud · 2024-11-07T13:16:05Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

feat(web): show-coherency-percencentage-instead-of-ratio

04e799d

coderabbitai bot requested changes Nov 7, 2024

View reviewed changes

web/src/pages/Home/TopJurors/JurorCard/Coherency.tsx Show resolved Hide resolved

web/src/pages/Home/TopJurors/Header/Coherency.tsx Outdated Show resolved Hide resolved

coderabbitai bot previously approved these changes Nov 7, 2024

View reviewed changes

kemuru previously approved these changes Nov 7, 2024

View reviewed changes

chore: remove space nitpick

a709812

kemuru dismissed stale reviews from coderabbitai[bot] and themself via a709812 November 7, 2024 13:13

kemuru self-requested a review November 7, 2024 13:13

kemuru approved these changes Nov 7, 2024

View reviewed changes

coderabbitai bot approved these changes Nov 7, 2024

View reviewed changes

jaybuidl added this pull request to the merge queue Nov 7, 2024

jaybuidl added Type: Feature🗿 Package: Web Court web frontend labels Nov 7, 2024

Merged via the queue into dev with commit 1165d3b Nov 7, 2024
28 checks passed

This was referenced Jan 27, 2025

feat: jurors page #1840

Merged

feat: new profile page #1871

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(web): show-coherency-percencentage-instead-of-ratio #1739

feat(web): show-coherency-percencentage-instead-of-ratio #1739

Harman-singh-waraich commented Nov 7, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Nov 7, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

netlify bot commented Nov 7, 2024 •

edited

Loading

netlify bot commented Nov 7, 2024 •

edited

Loading

netlify bot commented Nov 7, 2024 •

edited

Loading

netlify bot commented Nov 7, 2024 •

edited

Loading

coderabbitai bot left a comment

codeclimate bot commented Nov 7, 2024

sonarqubecloud bot commented Nov 7, 2024

feat(web): show-coherency-percencentage-instead-of-ratio #1739

feat(web): show-coherency-percencentage-instead-of-ratio #1739

Conversation

Harman-singh-waraich commented Nov 7, 2024 • edited by coderabbitai bot Loading

PR-Codex overview

Detailed summary

Summary by CodeRabbit

coderabbitai bot commented Nov 7, 2024 • edited Loading

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

netlify bot commented Nov 7, 2024 • edited Loading

✅ Deploy Preview for kleros-v2-testnet ready!

netlify bot commented Nov 7, 2024 • edited Loading

✅ Deploy Preview for kleros-v2-neo ready!

netlify bot commented Nov 7, 2024 • edited Loading

✅ Deploy Preview for kleros-v2-university ready!

netlify bot commented Nov 7, 2024 • edited Loading

✅ Deploy Preview for kleros-v2-testnet-devtools ready!

coderabbitai bot left a comment

Choose a reason for hiding this comment

codeclimate bot commented Nov 7, 2024

sonarqubecloud bot commented Nov 7, 2024

Quality Gate passed

Harman-singh-waraich commented Nov 7, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Nov 7, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

netlify bot commented Nov 7, 2024 •

edited

Loading

netlify bot commented Nov 7, 2024 •

edited

Loading

netlify bot commented Nov 7, 2024 •

edited

Loading

netlify bot commented Nov 7, 2024 •

edited

Loading