Skip to content
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

Move Carsus Notation to Getting Started section(#364) #430

Conversation

Nitish-Naik
Copy link

@Nitish-Naik Nitish-Naik commented Mar 4, 2025

📝 Description

Type: 🪲 bugfix | 📝 documentation |

This pull request moves the Carsus Notation content from the Developer Notes section to the Getting Started section of the documentation as requested in issue #364. This change improves the accessibility of important foundational concepts for new users by placing them earlier in the documentation.

Changes:
* Moved the Carsus Notation content to the Getting Started section.
* Updated any internal references and links to point to the new location.
* Ensured consistency in formatting and style across the updated section.

Closes #364: "Move Carsus Notation to Getting Started"

📌 Resources

    [Repository Documentation](https://tardis-sn.github.io/carsus/)
    [Issue #364](https://github.com/tardis-sn/carsus/issues/364)

🚦 Testing

How did you test these changes?

  • Testing pipeline
  • I ran the documentation locally using the make html command to generate the HTML files. I reviewed the output to ensure that the Carsus Notation was correctly moved to the Getting Started section, and I verified that all links and formatting are correct.

☑️ Checklist

  • I requested two reviewers for this pull request
  • I updated the documentation according to my changes
  • I built the documentation by applying the build_docs label

Screenshots

  • Before: Carsus Notation was in the Developer Notes section

beforeResolve

  • After: Carsus Notation has been moved to the Getting Started section

afterResolve

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link
Contributor

github-actions bot commented Mar 4, 2025

*beep* *bop*
Hi human,
I ran ruff on the latest commit (f9547fe).
Here are the outputs produced.
Results can also be downloaded as artifacts here.
Summarised output:

175	    	[ ] syntax-error
4	F405	[ ] undefined-local-with-import-star-usage
1	E402	[ ] module-import-not-at-top-of-file
1	F401	[*] unused-import

Complete output(might be large):

docs/conf.py:60:1: F405 `exclude_patterns` may be undefined, or defined from star imports
docs/conf.py:61:1: F405 `exclude_patterns` may be undefined, or defined from star imports
docs/conf.py:62:1: F405 `exclude_patterns` may be undefined, or defined from star imports
docs/conf.py:67:1: F405 `rst_epilog` may be undefined, or defined from star imports
docs/conf.py:132:1: E402 Module level import not at top of file
docs/development/compare_atomic_files.ipynb:cell 2:2:8: F401 [*] `logging` imported but unused
docs/development/index.rst:1:1: SyntaxError: Expected an expression
docs/development/index.rst:1:3: SyntaxError: Expected an expression
docs/development/index.rst:1:5: SyntaxError: Expected an expression
docs/development/index.rst:1:7: SyntaxError: Expected an expression
docs/development/index.rst:1:9: SyntaxError: Expected an expression
docs/development/index.rst:1:11: SyntaxError: Expected an expression
docs/development/index.rst:1:13: SyntaxError: Expected an expression
docs/development/index.rst:1:15: SyntaxError: Starred expression cannot be used here
docs/development/index.rst:1:16: SyntaxError: Expected an expression
docs/development/index.rst:2:11: SyntaxError: Simple statements must be separated by newlines or semicolons
docs/development/index.rst:3:1: SyntaxError: Expected an expression
docs/development/index.rst:3:3: SyntaxError: Expected an expression
docs/development/index.rst:3:5: SyntaxError: Expected an expression
docs/development/index.rst:3:7: SyntaxError: Expected an expression
docs/development/index.rst:3:9: SyntaxError: Expected an expression
docs/development/index.rst:3:11: SyntaxError: Expected an expression
docs/development/index.rst:3:13: SyntaxError: Expected an expression
docs/development/index.rst:3:15: SyntaxError: Starred expression cannot be used here
docs/development/index.rst:3:16: SyntaxError: Expected an expression
docs/development/index.rst:5:5: SyntaxError: Simple statements must be separated by newlines or semicolons
docs/development/index.rst:5:15: SyntaxError: Simple statements must be separated by newlines or semicolons
docs/development/index.rst:5:21: SyntaxError: Simple statements must be separated by newlines or semicolons
docs/development/index.rst:5:29: SyntaxError: Simple statements must be separated by newlines or semicolons
docs/development/index.rst:5:36: SyntaxError: Simple statements must be separated by newlines or semicolons
docs/development/index.rst:5:48: SyntaxError: Compound statements are not allowed on the same line as simple statements
docs/development/index.rst:5:63: SyntaxError: Expected 'in', found name
docs/development/index.rst:5:69: SyntaxError: Expected ':', found newline
docs/development/index.rst:6:1: SyntaxError: Expected an indented block after `for` statement
docs/development/index.rst:6:25: SyntaxError: Expected ',', found name
docs/development/index.rst:6:32: SyntaxError: Expected ',', found name
docs/development/index.rst:6:38: SyntaxError: Expected ',', found name
docs/development/index.rst:6:41: SyntaxError: Expected ',', found name
docs/development/index.rst:6:45: SyntaxError: Expected ',', found name
docs/development/index.rst:6:55: SyntaxError: Expected an identifier
docs/development/index.rst:8:1: SyntaxError: Expected a statement
docs/development/index.rst:8:2: SyntaxError: Expected a statement
docs/development/index.rst:8:12: SyntaxError: Expected an expression
docs/development/index.rst:8:13: SyntaxError: Expected a statement
docs/development/index.rst:9:1: SyntaxError: Unexpected indentation
docs/development/index.rst:9:5: SyntaxError: Expected a statement
docs/development/index.rst:14:1: SyntaxError: Expected a statement
docs/index.rst:1:1: SyntaxError: Expected an expression
docs/index.rst:1:3: SyntaxError: Expected an expression
docs/index.rst:1:5: SyntaxError: Expected an expression
docs/index.rst:1:7: SyntaxError: Expected an expression
docs/index.rst:1:9: SyntaxError: Expected an expression
docs/index.rst:1:11: SyntaxError: Expected an expression
docs/index.rst:1:13: SyntaxError: Expected an expression
docs/index.rst:1:15: SyntaxError: Expected an expression
docs/index.rst:1:17: SyntaxError: Expected an expression
docs/index.rst:1:19: SyntaxError: Expected an expression
docs/index.rst:1:21: SyntaxError: Expected an expression
docs/index.rst:1:23: SyntaxError: Expected an expression
docs/index.rst:1:25: SyntaxError: Expected an expression
docs/index.rst:1:27: SyntaxError: Expected an expression
docs/index.rst:1:29: SyntaxError: Expected an expression
docs/index.rst:1:31: SyntaxError: Expected an expression
docs/index.rst:1:33: SyntaxError: Expected an expression
docs/index.rst:1:35: SyntaxError: Expected an expression
docs/index.rst:2:9: SyntaxError: Simple statements must be separated by newlines or semicolons
docs/index.rst:2:12: SyntaxError: Simple statements must be separated by newlines or semicolons
docs/index.rst:2:18: SyntaxError: missing closing quote in string literal
docs/index.rst:2:35: SyntaxError: Expected a statement
docs/index.rst:3:1: SyntaxError: Expected an expression
docs/index.rst:3:3: SyntaxError: Expected an expression
docs/index.rst:3:5: SyntaxError: Expected an expression
docs/index.rst:3:7: SyntaxError: Expected an expression
docs/index.rst:3:9: SyntaxError: Expected an expression
docs/index.rst:3:11: SyntaxError: Expected an expression
docs/index.rst:3:13: SyntaxError: Expected an expression
docs/index.rst:3:15: SyntaxError: Expected an expression
docs/index.rst:3:17: SyntaxError: Expected an expression
docs/index.rst:3:19: SyntaxError: Expected an expression
docs/index.rst:3:21: SyntaxError: Expected an expression
docs/index.rst:3:23: SyntaxError: Expected an expression
docs/index.rst:3:25: SyntaxError: Expected an expression
docs/index.rst:3:27: SyntaxError: Expected an expression
docs/index.rst:3:29: SyntaxError: Expected an expression
docs/index.rst:3:31: SyntaxError: Expected an expression
docs/index.rst:3:33: SyntaxError: Expected an expression
docs/index.rst:3:35: SyntaxError: Expected an expression
docs/index.rst:5:13: SyntaxError: Simple statements must be separated by newlines or semicolons
docs/index.rst:5:21: SyntaxError: Simple statements must be separated by newlines or semicolons
docs/index.rst:5:24: SyntaxError: Simple statements must be separated by newlines or semicolons
docs/index.rst:5:31: SyntaxError: Simple statements must be separated by newlines or semicolons
docs/index.rst:5:38: SyntaxError: Simple statements must be separated by newlines or semicolons
docs/index.rst:5:51: SyntaxError: Simple statements must be separated by newlines or semicolons
docs/index.rst:5:55: SyntaxError: Simple statements must be separated by newlines or semicolons
docs/index.rst:5:60: SyntaxError: Simple statements must be separated by newlines or semicolons
docs/index.rst:5:65: SyntaxError: Simple statements must be separated by newlines or semicolons
docs/index.rst:5:72: SyntaxError: Expected 'import', found name
docs/index.rst:5:80: SyntaxError: Expected ',', found name
docs/index.rst:5:83: SyntaxError: Expected ',', found name
docs/index.rst:5:91: SyntaxError: Expected ',', found 'and'
docs/index.rst:5:102: SyntaxError: Expected ',', found name
docs/index.rst:5:107: SyntaxError: Expected ',', found name
docs/index.rst:5:110: SyntaxError: Expected ',', found name
docs/index.rst:5:115: SyntaxError: Expected ',', found name
docs/index.rst:5:123: SyntaxError: Expected ',', found name
docs/index.rst:5:132: SyntaxError: Expected ',', found name
docs/index.rst:5:135: SyntaxError: Expected ',', found name
docs/index.rst:5:145: SyntaxError: Expected ',', found name
docs/index.rst:5:154: SyntaxError: Expected ',', found name
docs/index.rst:5:159: SyntaxError: Expected ',', found '.'
docs/index.rst:7:1: SyntaxError: Expected a statement
docs/index.rst:7:2: SyntaxError: Expected a statement
docs/index.rst:7:12: SyntaxError: Expected an expression
docs/index.rst:7:13: SyntaxError: Expected a statement
docs/index.rst:8:1: SyntaxError: Unexpected indentation
docs/index.rst:8:5: SyntaxError: Expected a statement
docs/index.rst:9:5: SyntaxError: Expected a statement
docs/index.rst:9:23: SyntaxError: Simple statements must be separated by newlines or semicolons
docs/index.rst:17:1: SyntaxError: Expected a statement
docs/index.rst:17:2: SyntaxError: Expected a statement
docs/index.rst:17:12: SyntaxError: Expected an expression
docs/index.rst:17:13: SyntaxError: Expected a statement
docs/index.rst:18:1: SyntaxError: Unexpected indentation
docs/index.rst:18:5: SyntaxError: Expected a statement
docs/index.rst:19:5: SyntaxError: Expected a statement
docs/index.rst:20:5: SyntaxError: Expected a statement
docs/index.rst:20:13: SyntaxError: Expected an expression
docs/index.rst:31:1: SyntaxError: Expected a statement
docs/index.rst:31:2: SyntaxError: Expected a statement
docs/index.rst:31:12: SyntaxError: Expected an expression
docs/index.rst:31:13: SyntaxError: Expected a statement
docs/index.rst:32:1: SyntaxError: Unexpected indentation
docs/index.rst:32:5: SyntaxError: Expected a statement
docs/index.rst:33:5: SyntaxError: Expected a statement
docs/index.rst:34:5: SyntaxError: Expected a statement
docs/index.rst:34:13: SyntaxError: Expected an expression
docs/index.rst:39:1: SyntaxError: Expected a statement
docs/index.rst:39:2: SyntaxError: Expected a statement
docs/index.rst:39:12: SyntaxError: Expected an expression
docs/index.rst:39:13: SyntaxError: Expected a statement
docs/index.rst:40:1: SyntaxError: Unexpected indentation
docs/index.rst:40:5: SyntaxError: Expected a statement
docs/index.rst:41:5: SyntaxError: Expected a statement
docs/index.rst:41:24: SyntaxError: Compound statements are not allowed on the same line as simple statements
docs/index.rst:41:35: SyntaxError: Expected ',', found newline
docs/index.rst:42:13: SyntaxError: Expected an expression
docs/index.rst:48:1: SyntaxError: Expected a statement
docs/index.rst:48:2: SyntaxError: Expected a statement
docs/index.rst:48:12: SyntaxError: Expected an expression
docs/index.rst:48:13: SyntaxError: Expected a statement
docs/index.rst:49:1: SyntaxError: Unexpected indentation
docs/index.rst:49:5: SyntaxError: Expected a statement
docs/index.rst:50:5: SyntaxError: Expected a statement
docs/index.rst:50:28: SyntaxError: Simple statements must be separated by newlines or semicolons
docs/index.rst:50:31: SyntaxError: Simple statements must be separated by newlines or semicolons
docs/index.rst:51:5: SyntaxError: Expected a statement
docs/index.rst:51:13: SyntaxError: Expected an expression
docs/index.rst:56:1: SyntaxError: Expected a statement
docs/index.rst:56:2: SyntaxError: Expected a statement
docs/index.rst:56:12: SyntaxError: Expected an expression
docs/index.rst:56:13: SyntaxError: Expected a statement
docs/index.rst:57:1: SyntaxError: Unexpected indentation
docs/index.rst:57:5: SyntaxError: Expected a statement
docs/index.rst:58:5: SyntaxError: Expected a statement
docs/index.rst:59:5: SyntaxError: Expected a statement
docs/index.rst:59:13: SyntaxError: Expected an expression
docs/index.rst:64:1: SyntaxError: Expected a statement
docs/index.rst:64:2: SyntaxError: Expected a statement
docs/index.rst:64:12: SyntaxError: Expected an expression
docs/index.rst:64:13: SyntaxError: Expected a statement
docs/index.rst:65:1: SyntaxError: Unexpected indentation
docs/index.rst:65:10: SyntaxError: Simple statements must be separated by newlines or semicolons
docs/index.rst:65:14: SyntaxError: Got unexpected token ?
docs/index.rst:65:24: SyntaxError: Simple statements must be separated by newlines or semicolons
docs/index.rst:65:27: SyntaxError: Got unexpected token `
docs/index.rst:65:31: SyntaxError: Simple statements must be separated by newlines or semicolons
docs/index.rst:65:45: SyntaxError: Expected an expression
docs/index.rst:65:74: SyntaxError: Expected an expression
docs/index.rst:65:75: SyntaxError: Got unexpected token `
docs/index.rst:65:78: SyntaxError: Expected an identifier
docs/index.rst:66:1: SyntaxError: Expected a statement
Found 181 errors.
[*] 1 fixable with the `--fix` option.

@Nitish-Naik
Copy link
Author

Nitish-Naik commented Mar 4, 2025

@jvshields, @jselsing sir can you please review for this pull request.

@Nitish-Naik Nitish-Naik closed this by deleting the head repository Mar 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant