Update README.md with DOI #3758
Conversation
Changed the details to include the published paper and update authors.
WalkthroughThe pull request introduces updates to the README.md file for the German Building Stock Database. The changes primarily involve textual refinements, including clarifying language, updating references, and adding a new author. The modifications aim to improve the document's accuracy and readability by removing outdated phrases, specifying publication details, and expanding the list of contributors. Changes
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
cea/databases/DE/README.md (1)
11-11: Add missing determiner "An" for grammatical correctness.The sentence should begin with "An accompanying documentation.md file" for proper grammar.
-Building typology for the German building stock adapted to CEA database format. Accompanying documentation.md file details all assumptions and sources used to compile the database. Please cite the paper published at the BauSIM 2024 conference proceedings. +Building typology for the German building stock adapted to CEA database format. An accompanying documentation.md file details all assumptions and sources used to compile the database. Please cite the paper published at the BauSIM 2024 conference proceedings.🧰 Tools
🪛 LanguageTool
[uncategorized] ~11-~11: A determiner appears to be missing. Consider inserting it.
Context: ...g stock adapted to CEA database format. Accompanying documentation.md file details all assum...(AI_EN_LECTOR_MISSING_DETERMINER)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
cea/databases/DE/README.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
cea/databases/DE/README.md
[uncategorized] ~11-~11: A determiner appears to be missing. Consider inserting it.
Context: ...g stock adapted to CEA database format. Accompanying documentation.md file details all assum...
(AI_EN_LECTOR_MISSING_DETERMINER)
[style] ~13-~13: ‘overall goal’ might be wordy. Consider a shorter alternative.
Context: ...auSIM 2024 conference proceedings. The overall goal is to improve the current database crea...
(EN_WORDINESS_PREMIUM_OVERALL_GOAL)
🪛 Markdownlint (0.37.0)
cea/databases/DE/README.md
35-35: null
Bare URL used
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: windows-latest
- GitHub Check: macos-latest
- GitHub Check: ubuntu-latest
🔇 Additional comments (3)
cea/databases/DE/README.md (3)
13-13: Clear and well-structured goal statement.The statement effectively communicates the project's purpose and collaborative nature.
🧰 Tools
🪛 LanguageTool
[style] ~13-~13: ‘overall goal’ might be wordy. Consider a shorter alternative.
Context: ...auSIM 2024 conference proceedings. The overall goal is to improve the current database crea...(EN_WORDINESS_PREMIUM_OVERALL_GOAL)
18-21: Well-formatted citation with proper DOI link.The citation has been properly updated with the published paper details and includes a correctly formatted DOI link, which aligns with academic standards.
35-35: Author information follows consistent format.The new author entry maintains the established format and includes appropriate contact information.
🧰 Tools
🪛 Markdownlint (0.37.0)
35-35: null
Bare URL used(MD034, no-bare-urls)
ShiZhongming
merged commit 07f7688
into
architecture-building-systems:master
|
Thanks for the updates. It is now merged. |
Changed the details to include the published paper and update authors.
Summary by CodeRabbit