Skip to content

pgr_findCloseEdges: promotion to official #2778

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Mar 4, 2025
Merged

pgr_findCloseEdges: promotion to official #2778

merged 2 commits into from
Mar 4, 2025

Conversation

cvvergara
Copy link
Member

@cvvergara cvvergara commented Mar 3, 2025 •
edited by coderabbitai bot
Loading

Fixes #2774

Changes proposed in this pull request:

@pgRouting/admins

Summary by CodeRabbit

  • Documentation
    • Corrected several typographical errors to improve clarity.
    • Updated the status of a key function from proposed to official.
    • Refined documentation structure with improved section headers and removed redundant categories.
    • Enhanced overall consistency and presentation of release notes and related documentation.
    • Added a new section for the "Utilities family" in the documentation.

@cvvergara cvvergara added this to the Release 3.8.0 milestone Mar 3, 2025
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 3, 2025 •
edited
Loading

Walkthrough

This pull request updates the documentation to correct spelling errors (changing “Standarize” to “Standardize”) and to update the status of the function pgr_findCloseEdges from proposed to official. It also adjusts the document structure by adding a new rubric in the release notes, removing an outdated “Utilities Category” section, and incorporating new sections and hidden table-of-contents entries in other documentation files.

Changes

File(s) Change Summary
NEWS.md, doc/src/release_notes.rst Corrected spelling errors (“Standarize” → “Standardize”); promoted pgr_findCloseEdges in NEWS; added a new rubric (“Changes on proposed functions”) in release notes.
doc/src/proposed.rst Removed the “Utilities Category” section and its reference to pgr_findCloseEdges.
doc/src/routingFunctions.rst Added a new “Utilities family” section including a reference and hidden toctree entry for pgr_findCloseEdges.
doc/utilities/pgr_findCloseEdges.rst Removed “Proposed” labels; updated the documentation and version info to reflect the official status of pgr_findCloseEdges.
locale/en/LC_MESSAGES/pgrouting_doc_strings.po, locale/pot/pgrouting_doc_strings.pot Updated translation strings, corrected spelling errors, and reorganized sections related to pgr_findCloseEdges.

Suggested labels

Topology

Suggested reviewers

  • robe2

Poem

I’m a rabbit, hopping along the line,
Fixing typos and docs to make them shine.
Edges now official, no longer in a daze,
With neat new rubrics that amaze.
I nibble on changes with a playful cheer – hop, hop, hooray!
🐇✨

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 931adb3 and ef88a43.

📒 Files selected for processing (2)
  • locale/en/LC_MESSAGES/pgrouting_doc_strings.po (7 hunks)
  • locale/pot/pgrouting_doc_strings.pot (7 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (17)
locale/pot/pgrouting_doc_strings.pot (8)

11-11: Update to POT-Creation-Date is appropriate.

This timestamp update correctly reflects the regeneration date of the POT file as part of the promotion process.

3895-3899: Well-structured addition of Utilities family section.

Adding the "Utilities family" section with pgr_findCloseEdges properly categorizes the function as it's being promoted to official status. This organization will help users find the function more easily in the documentation.

3958-3960: Appropriate reorganization of documentation sections.

Moving "Changes on proposed functions" after the notes about pgr_findCloseEdges correctly reflects that this function is no longer in the proposed state but has been promoted to official status.

9862-9862: Clear documentation identifier for promoted function.

Adding a specific msgid entry for pgr_findCloseEdges ensures proper documentation is available for this newly promoted official function.

12877-12877: Spelling correction in reference to PR #2605.

Changed "Standarize" to "Standardize" which fixes a spelling error in the documentation. Good attention to detail!

13000-13013: Comprehensive documentation of standardization PRs.

This section properly documents several previous PRs that standardized output for various functions, providing valuable context about the project's evolution and consistency efforts.

13018-13022: Consistent documentation for proposed functions changes.

The documentation clearly separates proposed function changes from official function changes, maintaining a clear distinction for users.

13051-13054: Well-structured rubric addition for SQL standardization.

Adding a dedicated rubric for "Standardize SQL" improves the documentation structure and makes it easier for users to find related information.

locale/en/LC_MESSAGES/pgrouting_doc_strings.po (9)

11-11: Updated POT-Creation-Date properly.

The POT-Creation-Date has been updated to reflect the latest generation timestamp of the translation template file. This is a standard maintenance update for translations.

4373-4377: Appropriate categorization of pgr_findCloseEdges.

Adding the "Utilities family" section with pgr_findCloseEdges properly categorizes the function in the documentation structure. This aligns with the objective of promoting this function to official status.

4436-4437: Added appropriate section for proposed function changes.

The "Changes on proposed functions" section has been added, which provides clear organizational structure in the documentation for tracking changes to proposed functions.

11585-11585: Properly promoted pgr_findCloseEdges to official status.

The function reference has been updated to remove any "Proposed" prefix, which is consistent with its promotion to official status as stated in the PR objectives.

15331-15331: Corrected spelling from "Standarize" to "Standardize".

Fixed the spelling error in the GitHub pull request reference, improving the documentation quality.

15485-15517: Consistent spelling corrections across multiple entries.

All instances of "Standarize" have been corrected to "Standardize" across multiple GitHub pull request references, maintaining consistent terminology throughout the documentation.

15489-15490: Added new documentation line for standardization.

Added a new line describing the standardization of output columns, which provides better context for the changes being made across various functions.

15561-15561: Added new rubric for SQL standardization.

The addition of the "Standardize SQL" rubric helps organize related changes and improvements in the documentation structure.

15565-15565: Final spelling correction instance.

Corrected the last instance of "Standarize" to "Standardize" in the GitHub pull request reference, maintaining consistency throughout.

🪧 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[bot]
coderabbitai bot reviewed Mar 3, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 80fe73a and 931adb3.

📒 Files selected for processing (5)
  • NEWS.md (8 hunks)
  • doc/src/proposed.rst (0 hunks)
  • doc/src/release_notes.rst (6 hunks)
  • doc/src/routingFunctions.rst (2 hunks)
  • doc/utilities/pgr_findCloseEdges.rst (4 hunks)
💤 Files with no reviewable changes (1)
  • doc/src/proposed.rst
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
NEWS.md

24-24: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)

🪛 LanguageTool
NEWS.md

[style] ~219-~219: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...o Many) added end_vid column. * pgr_aStar(Many to One) added start_vid ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

[style] ~229-~229: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...o Many) added end_vid column. * pgr_bdAstar(Many to One) added ``start_vid`...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

[typographical] ~312-~312: Two consecutive dots
Context: ...490) Automatic page history links. * ..rubric:: Standardize SQL * [#2555](http...

(DOUBLE_PUNCTUATION)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (6)
doc/utilities/pgr_findCloseEdges.rst (1)

10-12: Index Directive Update.
The index entries now include both
  single: Utilities ; pgr_findCloseEdges
and
  single: findCloseEdges
which improves discoverability. Please confirm that both forms are intended and that no redundant entries are created.

doc/src/release_notes.rst (2)

42-50: Promotion Section Updated.
The release notes now include pgr_findCloseEdges under the rubric “Promotion to official function of pgRouting.” This change effectively communicates the new status. Ensure that any downstream references in other documentation (e.g., removal of the partial option) are consistent with this update.

56-57: New Rubric for Proposed Functions.
The insertion of the rubric “Changes on proposed functions” clearly isolates functions that remain proposed (such as pgr_degree). This helps for future tracking and aligns with the update to promote certain functions. Verify that no functions inadvertently remain listed as proposed if they have been officially promoted.

doc/src/routingFunctions.rst (2)

98-107: Addition of Utilities Family Section.
A new rubric “Utilities family” and a corresponding reference to :doc:\pgr_findCloseEdges`have been added. This improves the documentation’s organization by explicitly categorizingpgr_findCloseEdges` among utility functions. Please confirm that its placement (after sections covering other families) is intentional and follows the project’s documentation conventions.

173-174: Hidden Toctree Inclusion.
The hidden toctree now includes an entry for pgr_findCloseEdges, which ensures that the function’s documentation is part of the navigation even if it isn’t displayed in the main content. This is a good practice for comprehensive documentation.

NEWS.md (1)

10-24: Promotion Information in NEWS.md.
The NEWS.md file has been updated to reflect that pgr_findCloseEdges has been promoted to official status and that the partial option has been removed. This effectively communicates the changes in the function’s status. Please double-check that all spelling corrections (e.g. “Standardize”) are applied consistently throughout the document.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

24-24: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)

@robe2 robe2 self-requested a review March 4, 2025 02:34
@cvvergara cvvergara merged commit 4e64d97 into pgRouting:main Mar 4, 2025
2 checks passed
@cvvergara cvvergara deleted the issue-2774-promote-to-official-pgr_findCloseEdges branch March 4, 2025 03:31
@coderabbitai coderabbitai bot mentioned this pull request Mar 6, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Apr 4, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Apr 22, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@robe2 robe2 robe2 approved these changes

Assignees
No one assigned
Labels
functionality/official
Projects
None yet
Milestone
Release 3.8.0
Development

Successfully merging this pull request may close these issues.

Promote to official pgr_findCloseEdges in 3.8
2 participants
@cvvergara @robe2