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

Fixes spelling errors in the codebase #2938

Merged
merged 7 commits into from
Jan 21, 2025

Conversation

Sonu0305
Copy link
Contributor

@Sonu0305 Sonu0305 commented Jan 10, 2025

📝 Description

Type: 🪲 bugfix | 📝 documentation

renamed spelling tarids -> tardis

Closes #2937

📌 Resources

Examples, notebooks, and links to useful references.

🚦 Testing

How did you test these changes?

  • Testing pipeline
  • Other method (describe)
  • My changes can't be tested (explain why)

☑️ 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

Note: If you are not allowed to perform any of these actions, ping (@) a contributor.

@tardis-bot
Copy link
Contributor

tardis-bot commented Jan 10, 2025

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

1	ANN204	[ ] Missing return type annotation for special method `__getitem__`
1	I001  	[*] Import block is un-sorted or un-formatted
1	E999  	[ ] SyntaxError: Expected a statement
1	D202  	[*] No blank lines allowed after function docstring (found 1)
1	D406  	[*] Section name should end with a newline ("Returns")
1	D407  	[*] Missing dashed underline after section ("Returns")

Complete output(might be large):

docs/contributing/development/benchmarks.rst:1:1: E999 SyntaxError: Expected a statement
tardis/opacities/macro_atom/macroatom_state.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/opacities/opacity_state.py:210:9: ANN204 Missing return type annotation for special method `__getitem__`
tardis/opacities/opacity_state.py:216:9: D407 [*] Missing dashed underline after section ("Returns")
tardis/opacities/opacity_state.py:216:9: D406 [*] Section name should end with a newline ("Returns")
tardis/opacities/opacity_state.py:251:5: D202 [*] No blank lines allowed after function docstring (found 1)
Found 6 errors.
[*] 4 fixable with the `--fix` option.

@tardis-bot
Copy link
Contributor

tardis-bot commented Jan 10, 2025

*beep* *bop*

Hi, human.

The docs workflow has failed

Click here to see the build log.

@tardis-bot
Copy link
Contributor

tardis-bot commented Jan 10, 2025

*beep* *bop*
Hi human,
I ran benchmarks as you asked comparing master (2a06fdf) and the latest commit (d8178ac).
Here are the logs produced by ASV.
Results can also be downloaded as artifacts here.

Significantly changed benchmarks:

All benchmarks:

Benchmarks that have stayed the same:

| Change   | Before [5e2d0bb3] <master>   | After [d8178ac6]    | Ratio   | Benchmark (Parameter)                                                                                                               |
|----------|------------------------------|---------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------|
|          | 43.2±30μs                    | 62.9±30μs           | ~1.46   | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_line_scatter                                          |
|          | 1.47±0.6μs                   | 1.70±0.4μs          | ~1.16   | transport_geometry_calculate_distances.BenchmarkTransportGeometryCalculateDistances.time_calculate_distance_line                    |
|          | 7.29±2μs                     | 8.19±2μs            | ~1.12   | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket_volley                                    |
|          | 4.71±0.2ms                   | 3.86±0.01ms         | ~0.82   | opacities_opacity_state.BenchmarkOpacitiesOpacityState.time_opacity_state_initialize('macroatom')                                   |
|          | 632±200ns                    | 501±200ns           | ~0.79   | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_compton_opacity_calculation                                      |
|          | 57.7±20μs                    | 26.1±7μs            | ~0.45   | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_generate_rpacket_last_interaction_tracker_list |
|          | 42.9±30μs                    | 46.8±30μs           | 1.09    | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_line_emission                                         |
|          | 3.38±0.5μs                   | 3.64±6μs            | 1.08    | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_bad_vpacket                                       |
|          | 3.34±0.5μs                   | 3.57±0.4μs          | 1.07    | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket_within_shell                              |
|          | 3.15±0.02ms                  | 3.32±0.01ms         | 1.05    | opacities_opacity_state.BenchmarkOpacitiesOpacityState.time_opacity_state_initialize('scatter')                                     |
|          | 204±0.3ns                    | 210±0.6ns           | 1.03    | spectrum_formal_integral.BenchmarkTransportMontecarloFormalIntegral.time_intensity_black_body                                       |
|          | 2.82±0.4ms                   | 2.88±0.4ms          | 1.02    | transport_montecarlo_single_packet_loop.BenchmarkTransportMontecarloSinglePacketLoop.time_single_packet_loop                        |
|          | 541±200ns                    | 541±200ns           | 1.00    | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_photoabsorption_opacity_calculation                              |
|          | 2.10±0m                      | 2.10±0m             | 1.00    | spectrum_formal_integral.BenchmarkTransportMontecarloFormalIntegral.time_FormalIntegrator_functions                                 |
|          | 40.3±0.05s                   | 39.6±0.03s          | 0.98    | run_tardis.BenchmarkRunTardis.time_run_tardis                                                                                       |
|          | 1.07±0m                      | 1.05±0m             | 0.98    | run_tardis.BenchmarkRunTardis.time_run_tardis_rpacket_tracking                                                                      |
|          | 1.20±0μs                     | 1.17±0μs            | 0.98    | transport_geometry_calculate_distances.BenchmarkTransportGeometryCalculateDistances.time_calculate_distance_boundary                |
|          | 66.8±0.5ms                   | 65.8±0.05ms         | 0.98    | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_rpacket_trackers_to_dataframe                  |
|          | 736±0.8ns                    | 716±0.7ns           | 0.97    | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_thomson_scatter                                       |
|          | 2.39±2μs                     | 2.28±2μs            | 0.95    | transport_montecarlo_estimators_radfield_estimator_calcs.BenchmarkMontecarloMontecarloNumbaPacket.time_update_line_estimators       |
|          | 1.89±0.03ms                  | 1.79±0.03ms         | 0.95    | transport_montecarlo_main_loop.BenchmarkTransportMontecarloMontecarloMainLoop.time_montecarlo_main_loop                             |
|          | 40.6±0.04μs                  | 38.6±0.1μs          | 0.95    | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_generate_rpacket_tracker_list                  |
|          | 7.01±0.6μs                   | 6.59±1μs            | 0.94    | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket                                           |
|          | 551±100ns                    | 511±200ns           | 0.93    | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_pair_creation_opacity_calculation                                |

If you want to see the graph of the results, you can check it here

@Sonu0305
Copy link
Contributor Author

Hi @atharva-2001 @andrewfullard @jvshields ,
Could you please review when you have a chance, Thank You.

andrewfullard
andrewfullard previously approved these changes Jan 10, 2025
jvshields
jvshields previously approved these changes Jan 13, 2025
Copy link

codecov bot commented Jan 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.03%. Comparing base (2a06fdf) to head (d8178ac).
Report is 4 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2938      +/-   ##
==========================================
- Coverage   70.39%   70.03%   -0.36%     
==========================================
  Files         222      222              
  Lines       16157    16157              
==========================================
- Hits        11373    11316      -57     
- Misses       4784     4841      +57     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Sonu0305 Sonu0305 dismissed stale reviews from andrewfullard and jvshields via d8178ac January 14, 2025 13:36
@Sonu0305
Copy link
Contributor Author

Sonu0305 commented Jan 14, 2025

Hi @atharva-2001 @andrewfullard @jvshields @KasukabeDefenceForce ,
Could you please review when you have a chance, Thank You.

@andrewfullard andrewfullard merged commit 145a995 into tardis-sn:master Jan 21, 2025
16 of 18 checks passed
@Sonu0305 Sonu0305 deleted the fix#misspell branch January 24, 2025 18:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Tardis spelled as Tarids at few places
4 participants