docs: english-only public docs and reposition around the source paper#225
Merged
Conversation
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



Greptile Summary
This PR consolidates the public documentation to English-only, repositions the project around the original Vrana et al. (2021) source paper, and flattens the language-subdirectory structure (
en/,cs/) across examples, data files, and UML diagrams.examples/en/andexamples/cs/are deleted; their content is inlined into the top-levelexamples/analyze_*.pywrappers, and data files are promoted fromexamples/data/en/toexamples/data/.enandcslocales, keeping the locales parallel.Confidence Score: 4/5
Safe to merge; the structural changes are consistent and the data files exist at the new paths.
All path consolidations are correct — data files land at
examples/data/and tests confirm that. The only carry-over is the non-ASCIIΔcharacter that was already present in the now-deletedexamples/en/files and has been inlined into the three top-level example scripts without remediation.examples/analyze_budget_case.py, examples/analyze_floods_case.py, examples/analyze_pendlers_case.py — each contains a Δ character in a print statement that violates the ASCII-only rule.
Important Files Changed
en/to the new top-level path. No issues.examples/en/analyze_budget_case.py; non-ASCII Δ character carried over into the print statement at line 48 (py-ascii-only violation).examples/en/analyze_floods_case.py; same non-ASCII Δ character at line 51.examples/en/analyze_pendlers_case.py; same non-ASCII Δ character at line 70.DATA_DIR / "en" / ...toDATA_DIR / ...; files exist at the new location.TestRunAnalysisWithCzechnow loads English data with Czech labels — structurally correct since numeric values are identical.lang_rootsdict; English diagrams now live at the top-level directory, Czech diagrams incs/(gitignored). Logic is correct and skips the CS path gracefully when absent.implementationAuthorandimplementationThesiskeys to drop thesis branding; matching keys updated inlocales/cs/common.json— i18n-parallel-locales rule satisfied.docs/uml-diagrams/cs/,examples/cs/,examples/data/cs/,examples/visualizations/cs/) to keep them local-only. Correct.Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD A[examples/analyze_budget_case.py\nanalyze_floods_case.py\nanalyze_pendlers_case.py] -->|reads| B[examples/data/budget_case.txt\nfloods_case.txt\npendlers_case.txt] A -->|uses| C[examples/utils/runner.run_analysis] C -->|invokes| D[BeCoMeCalculator] D -->|arithmetic mean| E[FuzzyTriangleNumber - Gamma] D -->|median| F[FuzzyTriangleNumber - Omega] E & F -->|component-wise avg| G[best_compromise] G --> H[AnalysisResult frozen dataclass] H --> I[print interpretation + delta_max] subgraph deleted X[examples/en/analyze_*.py] Y[examples/cs/analyze_*.py] Z[examples/data/en/*.txt] W[examples/data/cs/*.txt] endPrompt To Fix All With AI
Reviews (1): Last reviewed commit: "test: load runner case data from flatten..." | Re-trigger Greptile