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.

Sign up for GitHub

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

Jump to bottom

Tweaking the documentation strings #89

Merged
merged 5 commits into from
May 21, 2019
Merged

Tweaking the documentation strings #89

merged 5 commits into from
May 21, 2019

Conversation

dkfellows
Copy link
Member

Documentation fixes

@dkfellows dkfellows self-assigned this Jun 19, 2018
@coveralls
Copy link

coveralls commented Jun 19, 2018 •
edited

Pull Request Test Coverage Report for Build 1709

  • 18 of 83 (21.69%) changed or added relevant lines in 2 files are covered.
  • 5 unchanged lines in 2 files lost coverage.
  • Overall coverage increased (+0.6%) to 35.05%
Changes Missing Coverage Covered Lines Changed/Added Lines %
spinnaker_graph_front_end/init.py 7 72 9.72%
Files with Coverage Reduction New Missed Lines %
spinnaker_graph_front_end/spinnaker.py 1 48.28%
spinnaker_graph_front_end/init.py 4 35.77%
Totals Coverage Status
Change from base Build 1704: 0.6%
Covered Lines: 211
Relevant Lines: 602
💛 - Coveralls

@dkfellows
Tweaking the documentation strings
5cbc75e
@dkfellows
Rework the core of the GFE to produce much clearer documentation
b7016c1 
Note that this moves two classes into spinnaker.py as they were very
small and uninteresting in themselves. Moving them in (and making one be
private/undocumented) helps make the documentation quite a bit simpler.
@dkfellows
Copy link
Member Author

This ended up as a slightly more thorough rework of the core of the GFE than I originally expected. In particular, I got rid of two files that had tiny classes in them, moving those classes into spinnaker.py (and making the failed state class be not documented by default). This produces quite a bit clearer documentation, and nails out of sight a class that users shouldn't usually be messing with.

@rowleya
Merge branch 'master' into doc-tweak
5ccc00b 
Conflicts:
	spinnaker_graph_front_end/examples/Conways/partitioned_example_a_no_vis_no_buffer/conways_cell.c
	spinnaker_graph_front_end/examples/speed_test_solo/main_solo.py
	spinnaker_graph_front_end/examples/speed_test_solo/packet_gatherer_cheat.c
	spinnaker_graph_front_end/examples/speed_test_solo/packet_gatherer_cheat.py
	spinnaker_graph_front_end/examples/speed_tracker/main.py
	spinnaker_graph_front_end/examples/speed_tracker/sdram_reader_and_transmitter.c
	spinnaker_graph_front_end/examples/speed_tracker_with_protocol/main.py
	spinnaker_graph_front_end/examples/speed_tracker_with_protocol/packet_gatherer.c
	spinnaker_graph_front_end/examples/speed_tracker_with_protocol/packet_gatherer_with_protocol.py
	spinnaker_graph_front_end/examples/speed_tracker_with_protocol/sdram_reader_and_transmitter_with_protocol.c
	spinnaker_graph_front_end/examples/speed_tracker_with_protocol_search/packet_gatherer.c
	spinnaker_graph_front_end/examples/speed_tracker_with_protocol_search/packet_gatherer_with_protocol.py
	spinnaker_graph_front_end/examples/speed_tracker_with_protocol_search/sdram_reader_and_transmitter_with_protocol.c
	spinnaker_graph_front_end/examples/speed_tracker_with_protocol_search_c_code_version/packet_gatherer.c
	spinnaker_graph_front_end/examples/speed_tracker_with_protocol_search_c_code_version/packet_gatherer_with_protocol.py
	spinnaker_graph_front_end/examples/speed_tracker_with_protocol_search_c_code_version/sdram_reader_and_transmitter_with_protocol.c
	spinnaker_graph_front_end/examples/template/c_template_vertex.c
	spinnaker_graph_front_end/examples/test_extra_monitor_core_data_extraction/sdram_writer.c
	spinnaker_graph_front_end/examples/test_fixed_router/hello_world.py
	spinnaker_graph_front_end/examples/test_fixed_router/hello_world_vertex.py
	spinnaker_graph_front_end/examples/test_fixed_router/hello_world_vertex_clone.py
	spinnaker_graph_front_end/examples/test_fixed_router_transmitter_reciever/hello_world.py
	spinnaker_graph_front_end/examples/test_fixed_router_transmitter_reciever/hello_world_vertex.py
	spinnaker_graph_front_end/examples/test_fixed_router_transmitter_reciever/hello_world_vertex_clone.py
	spinnaker_graph_front_end/examples/test_retransmission_phase_on_multi_cores/main.py
	spinnaker_graph_front_end/examples/test_retransmission_phase_on_multi_cores/packet_gatherer.c
	spinnaker_graph_front_end/examples/test_retransmission_phase_on_multi_cores/packet_gatherer_with_protocol.py
	spinnaker_graph_front_end/examples/test_retransmission_phase_on_multi_cores/sdram_reader_and_transmitter_with_protocol.c
	spinnaker_graph_front_end/graph_front_end_simulator_interface.py
	spinnaker_graph_front_end/spinnaker.py
	spinnaker_graph_front_end/utilities/__init__.py
	spinnaker_graph_front_end/utilities/graph_front_end_failed_state.py
@rowleya
flake8 fix
efab20a
@rowleya rowleya merged commit 020146e into master May 21, 2019
@rowleya rowleya deleted the doc-tweak branch May 21, 2019 17:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alan-stokes alan-stokes Awaiting requested review from alan-stokes

Assignees

@dkfellows dkfellows

Labels
enhancement minor
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@dkfellows @coveralls @rowleya