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

Fix spacing between NOTAMs and closing statement #126

Merged
merged 1 commit into from
Feb 7, 2025

Conversation

justinshannon
Copy link
Contributor

@justinshannon justinshannon commented Feb 7, 2025

Summary by CodeRabbit

  • Style
    • Adjusted how extra spacing is handled in ATIS messages, so additional spaces (including leading and trailing) are now preserved during display.
    • Enhanced NOTAM text formatting by appending a trailing space to improve the separation and readability of message content.

Copy link
Contributor

coderabbitai bot commented Feb 7, 2025

Walkthrough

This pull request updates the AtisBuilder class in vATIS.Desktop/Atis/AtisBuilder.cs. The RemoveTextParsingCharacters method no longer eliminates extra spaces before punctuation. Additionally, the instantiation of WX, ARPT_COND, and NOTAMS variables now omits the Trim() call on their text and voice properties, preserving any whitespace. A space is now appended to the end of the NOTAMs string. There are no changes to exported or public entity declarations.

Changes

File(s) Change Summary
vATIS.Desktop/Atis/AtisBuilder.cs Removed extra space removal in RemoveTextParsingCharacters; modified WX, ARPT_COND, and NOTAMS variable constructions by omitting Trim() calls; appended a space to the NOTAMs string.

Possibly related PRs

Poem

I'm a bunny coding through the night,
Hoping spaces in strings keep shining bright.
No more trimming at the break of code,
Instead, extra whitespace now takes its road.
With a skip and a hop, improvements are here to delight! 🐇
Happy trails in text, let every detail ignite!


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0527dae and b478cb6.

📒 Files selected for processing (1)
  • vATIS.Desktop/Atis/AtisBuilder.cs (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: build (macos-latest)
  • GitHub Check: Analyze (cpp)
  • GitHub Check: build (windows-latest)
  • GitHub Check: Analyze (csharp)
  • GitHub Check: build (ubuntu-latest)
  • GitHub Check: Analyze (cpp)
  • GitHub Check: Analyze (csharp)
🔇 Additional comments (2)
vATIS.Desktop/Atis/AtisBuilder.cs (2)

476-478: LGTM! Preserving whitespace in ATIS variables.

The removal of Trim() calls on WX, ARPT_COND, and NOTAMS variables aligns with the PR objective to fix spacing issues.


432-433: Verify the impact of adding a space after NOTAMs.

The addition of a space after NOTAMs could affect the formatting of the closing statement. Please ensure this change doesn't create unintended double spaces when combined with other sections of the ATIS message.

✅ Verification successful

🏁 Script executed:

#!/bin/bash
# Description: Check if there are any double spaces in the ATIS message after NOTAMs.
# Look for patterns where NOTAMs are followed by closing statements or other sections.

ast-grep --pattern 'template += closingTemplate'

Length of output: 50


🏁 Script executed:

#!/bin/bash
# Script: Examine the context around the NOTAMs modification and its concatenation with other message parts.
# 1. Show the context where NOTAMs is modified to add a trailing space.
sed -n '420,460p' vATIS.Desktop/Atis/AtisBuilder.cs

# 2. Search for any usage of "closingTemplate" or any concatenation involving NOTAMs to check for potential double spacing.
rg -n -C5 "closingTemplate" vATIS.Desktop/Atis/AtisBuilder.cs

# 3. List all occurrences of the "notams" variable to see how it is used later in the file.
rg -n "notams" vATIS.Desktop/Atis/AtisBuilder.cs

Length of output: 3513


Verified: The appended trailing space in the NOTAMs string does not cause unintended double spacing.

The context confirms that the NOTAMs string—after being trimmed and appended with a space—is only substituted into the NOTAMS template. The closing statement is concatenated separately via its own logic (using a different template variable), so the added space does not merge with the closing text.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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. (Beta)
  • @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.

@justinshannon justinshannon added this pull request to the merge queue Feb 7, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Feb 7, 2025
@justinshannon justinshannon added this pull request to the merge queue Feb 7, 2025
Merged via the queue into main with commit 3e58287 Feb 7, 2025
9 checks passed
@justinshannon justinshannon deleted the fix/text-atis-spacing branch February 7, 2025 23:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant