Misc updates#9
Conversation
Summary of ChangesHello @jen-reeve, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a series of updates across various dictionary files, primarily focusing on expanding vocabulary, adding new acronyms, commands, and software names, and enhancing existing entries with linguistic attributes like possessive forms. The changes aim to enrich the available terminology within the system, improving its comprehensiveness and accuracy across different domains. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
JSON and YAML Validation ResultsYAML Validation Results
Violations: [
{
"file": "dic/software_names.yaml",
"errors": [
{
"path": null,
"message": "Invalid YAML",
"error": "YAMLParseError Map keys must be unique at line 16, column 6"
}
]
}
] |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds various terms to the dictionary files. The changes are mostly good, but there are a few issues to address. I've found a critical schema violation in dic/software_names.yaml that needs to be fixed. I've also left comments regarding typos, inconsistencies in formatting (like trailing spaces and boolean capitalization), and missing newlines at the end of files. Additionally, one of the software names seems to have incorrect capitalization, and one of the miscellaneous dictionary files could benefit from being sorted alphabetically for better maintainability.
| crontab: | ||
| Illumina: | ||
| ImagMagick: | ||
| IOBUF: |
There was a problem hiding this comment.
The entry Julia+Pluto.ji has a couple of issues:
- It violates the project's schema for dictionary keys (
/^[^\w\-]+$/), as+is not an allowed character. This is a critical issue that will likely break the build. - The
.jiextension appears to be a typo for.jl, the correct extension for Julia files and Pluto notebooks.
There is also a separate Pluto.ji entry on line 47 which seems redundant and also has the .jl typo.
Consider replacing these with valid and correct entries, for example, separate entries for Julia and Pluto.jl.
| srun: No newline at end of file | ||
| srun: | ||
| sbatch: | ||
| env: No newline at end of file |
There was a problem hiding this comment.
This file is missing a final newline character. It's a good practice to end files with a single newline for POSIX compatibility and to prevent issues with some command-line tools.
| rollout: | ||
| Ancil: Short for Ancilliary | ||
| md: | ||
| venv: Virtual environment |
There was a problem hiding this comment.
For consistency with other dictionary files and for better maintainability, it's good practice to keep entries sorted alphabetically. This file is currently not sorted. Consider sorting all entries alphabetically.
| FreeIPA: | ||
| GeneMark: | ||
| GridRunner: | ||
| GTK: open-source toolkit for creating graphical user interfaces |
There was a problem hiding this comment.
There appears to be a typo in ImagMagick. The correct spelling is ImageMagick.
ImageMagick:| Keras: | ||
| Keycloak: | ||
| Kibana: Kibana is a source-available data visualization dashboard software for Elasticsearch. | ||
| Kraken: |
There was a problem hiding this comment.
The software is usually referred to as Lmod. For consistency, it would be better to use the correct capitalization, especially since checkcase is on by default for most entries. An entry for Lmod already exists in dic/proper_names.yaml.
Lmod:| ora: | ||
| Manaaki: | ||
| Whenua: | ||
| Ōtautahi: |
There was a problem hiding this comment.
This line has a trailing space. Several other new lines also have trailing spaces (e.g., 23, 25, 27, 34, 36, 38). These should be removed to keep the file clean and consistent.
Ōtautahi:| Manaaki: | ||
| Whenua: | ||
| Ōtautahi: | ||
| possessive: True |
There was a problem hiding this comment.
The boolean value True is used here and on lines 24, 26, 28, 30, 32, 35, 37, and 39. However, other YAML files in this project use lowercase true. While YAML parsers handle both, it's best to be consistent across the project. Please use true.
possessive: true
JSON and YAML Validation ResultsYAML Validation Results
Violations: [
{
"file": "dic/software_names.yaml",
"errors": [
{
"path": null,
"message": "Invalid YAML",
"error": "YAMLParseError Map keys must be unique at line 16, column 6"
}
]
}
] |
1 participant
No description provided.