Skip to content

Remove outdated contact information, esp. mail addresses #4499

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

Merged
merged 2 commits into from
Apr 15, 2025

Conversation

beutlich
Copy link
Member

@beutlich beutlich commented Nov 4, 2024

Summary by CodeRabbit

  • Documentation
    • Updated contributor and author contact information in multiple documentation sections to clarify past affiliations and remove email addresses.
    • Adjusted formatting of contributor affiliations for improved clarity.
    • Changed some contact links from email to GitHub profiles.
    • No changes to functionality or exported entities.

@beutlich beutlich added L: Icons Issue addresses Modelica.Icons L: Media Issue addresses Modelica.Media L: UsersGuide Issue addresses Modelica.UsersGuide labels Nov 4, 2024
@beutlich beutlich requested review from casella and AHaumer and removed request for mtiller and hubertus65 January 15, 2025 20:03
@beutlich beutlich added this to the MSL4.1.0 milestone Mar 3, 2025
Copy link

coderabbitai bot commented Apr 15, 2025

Walkthrough

The changes update documentation metadata across several Modelica package files. Specifically, author and contributor contact information is revised to clarify previous affiliations by adding "previously at" before former employers and removing email addresses. In some cases, email links are replaced with GitHub profile URLs. All modifications are limited to documentation text, with no changes to code logic, exported entities, or functional behavior.

Changes

File(s) Change Summary
Modelica/Icons.mo Updated documentation to clarify Johan Andreasson's previous affiliation and removed his email address.
Modelica/Media/Water/IF97_Utilities.mo Revised author attribution for Hubertus Tummescheit to indicate previous affiliation; removed email addresses; replaced some email links with GitHub URLs in documentation.
Modelica/Media/package.mo Updated Hubertus Tummescheit's author information to indicate previous affiliation and removed email addresses in documentation.
Modelica/UsersGuide/Contact.mo Updated contributor information to clarify current and previous affiliations for Michael Tiller and Hubertus Tummescheit; adjusted formatting.

Poem

A hop and a skip through docs we go,
Affiliations updated, just so you know!
Old emails vanish, new credits appear,
"Previously at" whispers—histories clear.
Rabbits love tidy burrows and names,
Now our docs reflect past Modelica games!
🐇✨

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 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 1353d2c and 293df5f.

📒 Files selected for processing (4)
  • Modelica/Icons.mo (1 hunks)
  • Modelica/Media/Water/IF97_Utilities.mo (10 hunks)
  • Modelica/Media/package.mo (2 hunks)
  • Modelica/UsersGuide/Contact.mo (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: external_c_checks_cmake_windows-msvc
  • GitHub Check: external_c_checks_cmake_windows-cygwin
🔇 Additional comments (4)
Modelica/Icons.mo (1)

807-811: Contact info update is correct and appropriate.

The change to indicate "previously at" and removal of the email address is accurate, improves privacy, and aligns with the PR objective. No further action needed.

Modelica/UsersGuide/Contact.mo (1)

404-407: Contributor affiliation updates are accurate and clear.

The changes clarify current and past affiliations, improving documentation accuracy. No further action needed.

Also applies to: 416-417

Modelica/Media/Water/IF97_Utilities.mo (1)

87-91: Author attribution and contact info updates are correct.

The documentation now accurately reflects past affiliations and removes outdated email addresses, in line with the PR objective. No further action needed.

Also applies to: 150-154, 182-186, 3854-3858, 5011-5015, 6164-6169, 8713-8722

Modelica/Media/package.mo (1)

2018-2022: Author contact information updates are correct.

The documentation now accurately reflects past affiliations and removes outdated email addresses, in line with the PR objective. No further action needed.

Also applies to: 5115-5119


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

Copy link
Contributor

@AHaumer AHaumer left a comment

Choose a reason for hiding this comment

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

LGTM

@casella casella merged commit b9f2a3d into modelica:master Apr 15, 2025
12 checks passed
@beutlich beutlich deleted the fix-contact branch April 15, 2025 09:38
@beutlich beutlich modified the milestones: MSL4.1.0, maintenance Apr 15, 2025
@beutlich beutlich added the documentation Issue addresses the documentation label Apr 15, 2025
@Esther-Devakirubai
Copy link
Contributor

Resolved by 4627 and Backported to maint/4.1.x by #4628

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issue addresses the documentation L: Icons Issue addresses Modelica.Icons L: Media Issue addresses Modelica.Media L: UsersGuide Issue addresses Modelica.UsersGuide
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants