Merge pull request #85 from ncusi/documentation - docs/author_statist…

…ics.md Documentation: Add docs/author_statistics.md
ncusi · Dec 30, 2024 · 99863cb · 99863cb
2 parents 8fe434a + 49bf54e
commit 99863cb
Show file tree

Hide file tree

Showing 50 changed files with 486 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -118,7 +118,7 @@ See the basic [demo on Heroku](https://patchscope-9d05e7f15fec.herokuapp.com/):
 
 You can find description of those two apps, with screenshots, at
 
-- `docs/author_statistics.md` (**TODO**)
+- [`docs/author_statistics.md`](docs/author_statistics.md)
 - [`docs/contributors_graph.md`](docs/contributors_graph.md)
 
 [Panel]: https://panel.holoviz.org/

diff --git a/docs/assets/day_of_week-localtime_vs_UTC-ezhulenev.png b/docs/assets/day_of_week-localtime_vs_UTC-ezhulenev.png
diff --git a/docs/assets/defects4j_dissection.Listing_1.Closure-40.1x.png b/docs/assets/defects4j_dissection.Listing_1.Closure-40.1x.png
diff --git a/docs/assets/defects4j_dissection.Listing_1.Closure-40.2x.png b/docs/assets/defects4j_dissection.Listing_1.Closure-40.2x.png
diff --git a/docs/assets/hour_UTC_vs_hour_localtime-ezhulenev.png b/docs/assets/hour_UTC_vs_hour_localtime-ezhulenev.png
diff --git a/docs/assets/screenshots/github-qtile_qtile-code_frequency.png b/docs/assets/screenshots/github-qtile_qtile-code_frequency.png
diff --git a/...sets/screenshots/github-qtile_qtile-graphs_contributors-all-additions-tych0.png b/...sets/screenshots/github-qtile_qtile-graphs_contributors-all-additions-tych0.png
diff --git a/docs/assets/screenshots/github-qtile_qtile-graphs_contributors-all-additions.png b/docs/assets/screenshots/github-qtile_qtile-graphs_contributors-all-additions.png
diff --git a/...ets/screenshots/github-qtile_qtile-graphs_contributors-all-commits-tych0.v1.png b/...ets/screenshots/github-qtile_qtile-graphs_contributors-all-commits-tych0.v1.png
diff --git a/...ets/screenshots/github-qtile_qtile-graphs_contributors-all-commits-tych0.v2.png b/...ets/screenshots/github-qtile_qtile-graphs_contributors-all-commits-tych0.v2.png
diff --git a/docs/assets/screenshots/github-qtile_qtile-graphs_contributors-all-commits.png b/docs/assets/screenshots/github-qtile_qtile-graphs_contributors-all-commits.png
diff --git a/docs/assets/screenshots/github-qtile_qtile-graphs_contributors-all-deletions.png b/docs/assets/screenshots/github-qtile_qtile-graphs_contributors-all-deletions.png
diff --git a/docs/assets/screenshots/github-tych0_contributions_heatmap.png b/docs/assets/screenshots/github-tych0_contributions_heatmap.png
diff --git a/docs/assets/screenshots/github-yongtang_contributions_heatmap.png b/docs/assets/screenshots/github-yongtang_contributions_heatmap.png
diff --git a/.../assets/screenshots/patchscope-author-qtile-Tycho_Andersen-commit_counts-QE.png b/.../assets/screenshots/patchscope-author-qtile-Tycho_Andersen-commit_counts-QE.png
diff --git a/docs/assets/screenshots/patchscope-author-qtile-Tycho_Andersen-commit_counts-W.png b/docs/assets/screenshots/patchscope-author-qtile-Tycho_Andersen-commit_counts-W.png
diff --git a/..._Andersen-histogram_of_line_counts_per_commit-bw=1-max_val=35-with_controls.png b/..._Andersen-histogram_of_line_counts_per_commit-bw=1-max_val=35-with_controls.png
diff --git a/...r-qtile-Tycho_Andersen-histogram_of_line_counts_per_commit-bw=3-max_val=100.png b/...r-qtile-Tycho_Andersen-histogram_of_line_counts_per_commit-bw=3-max_val=100.png
diff --git a/...ssets/screenshots/patchscope-author-qtile-Tycho_Andersen-line_counts-ME-sum.png b/...ssets/screenshots/patchscope-author-qtile-Tycho_Andersen-line_counts-ME-sum.png
diff --git a/...ssets/screenshots/patchscope-author-qtile-Tycho_Andersen-line_counts-QE-sum.png b/...ssets/screenshots/patchscope-author-qtile-Tycho_Andersen-line_counts-QE-sum.png
diff --git a/...assets/screenshots/patchscope-author-qtile-Tycho_Andersen-line_counts-W-sum.png b/...assets/screenshots/patchscope-author-qtile-Tycho_Andersen-line_counts-W-sum.png
diff --git a/...hots/patchscope-author-qtile-Tycho_Andersen-line_type-type_code_perc-QE-sum.png b/...hots/patchscope-author-qtile-Tycho_Andersen-line_type-type_code_perc-QE-sum.png
diff --git a/...reenshots/patchscope-author-qtile-Tycho_Andersen-line_type-type_data-QE-sum.png b/...reenshots/patchscope-author-qtile-Tycho_Andersen-line_type-type_data-QE-sum.png
diff --git a/docs/assets/screenshots/patchscope-author-qtile-Tycho_Andersen-patch_sizes-QE.png b/docs/assets/screenshots/patchscope-author-qtile-Tycho_Andersen-patch_sizes-QE.png
diff --git a/...creenshots/patchscope-author-qtile-Tycho_Andersen-periodic_behavior_heatmap.png b/...creenshots/patchscope-author-qtile-Tycho_Andersen-periodic_behavior_heatmap.png
diff --git a/...hots/patchscope-author-tensorflow-Eugene_Zhulenev-periodic_behavior_heatmap.png b/...hots/patchscope-author-tensorflow-Eugene_Zhulenev-periodic_behavior_heatmap.png
diff --git a/...ts/patchscope-author-tensorflow-Yong_Tang-line_type-heatmap-ME-sum-cmap_log.png b/...ts/patchscope-author-tensorflow-Yong_Tang-line_type-heatmap-ME-sum-cmap_log.png
diff --git a/...creenshots/patchscope-author-tensorflow-Yong_Tang-periodic_behavior_heatmap.png b/...creenshots/patchscope-author-tensorflow-Yong_Tang-periodic_behavior_heatmap.png
diff --git a/...assets/screenshots/patchscope-contributors-hellogitworld-all-sankey_diagram.png b/...assets/screenshots/patchscope-contributors-hellogitworld-all-sankey_diagram.png
diff --git a/docs/assets/screenshots/patchscope-contributors-qtile-all-additions_plot.png b/docs/assets/screenshots/patchscope-contributors-qtile-all-additions_plot.png
diff --git a/docs/assets/screenshots/patchscope-contributors-qtile-all-commits_plot.png b/docs/assets/screenshots/patchscope-contributors-qtile-all-commits_plot.png
diff --git a/docs/assets/screenshots/patchscope-contributors-qtile-all-deletions_plot.png b/docs/assets/screenshots/patchscope-contributors-qtile-all-deletions_plot.png
diff --git a/docs/assets/screenshots/patchscope-contributors-qtile-all-files_changed-export.png b/docs/assets/screenshots/patchscope-contributors-qtile-all-files_changed-export.png
diff --git a/docs/assets/screenshots/patchscope-contributors-qtile-all-files_changed.png b/docs/assets/screenshots/patchscope-contributors-qtile-all-files_changed.png
diff --git a/...ssets/screenshots/patchscope-contributors-qtile-all-line_types_perc_heatmap.png b/...ssets/screenshots/patchscope-contributors-qtile-all-line_types_perc_heatmap.png
diff --git a/...ssets/screenshots/patchscope-contributors-qtile-all-no_plot-line_types_perc.png b/...ssets/screenshots/patchscope-contributors-qtile-all-no_plot-line_types_perc.png
diff --git a/docs/assets/screenshots/patchscope-contributors-qtile-all-patch_size.png b/docs/assets/screenshots/patchscope-contributors-qtile-all-patch_size.png
diff --git a/docs/assets/screenshots/patchscope-contributors-qtile-all-patch_spreading.png b/docs/assets/screenshots/patchscope-contributors-qtile-all-patch_spreading.png
diff --git a/...-contributors-qtile-all-perspective-authors_info_df-x_bar-n_commits_groupby.png b/...-contributors-qtile-all-perspective-authors_info_df-x_bar-n_commits_groupby.png
diff --git a/...s/patchscope-contributors-qtile-all-perspective-data_df-xy_scatter-pm_count.png b/...s/patchscope-contributors-qtile-all-perspective-data_df-xy_scatter-pm_count.png
diff --git a/...enshots/patchscope-contributors-qtile-all-perspective-resampled_df-datagrid.png b/...enshots/patchscope-contributors-qtile-all-perspective-resampled_df-datagrid.png
diff --git a/...qtile-all-perspective-resampled_df-xy_scatter-patch_size_vs_patch_spreading.png b/...qtile-all-perspective-resampled_df-xy_scatter-patch_size_vs_patch_spreading.png
diff --git a/...nshots/patchscope-contributors-qtile-per_author-Tycho_Andersen-additions-QE.png b/...nshots/patchscope-contributors-qtile-per_author-Tycho_Andersen-additions-QE.png
diff --git a/...enshots/patchscope-contributors-qtile-per_author-Tycho_Andersen-additions-W.png b/...enshots/patchscope-contributors-qtile-per_author-Tycho_Andersen-additions-W.png
diff --git a/...eenshots/patchscope-contributors-qtile-per_author-Tycho_Andersen-commits-QE.png b/...eenshots/patchscope-contributors-qtile-per_author-Tycho_Andersen-commits-QE.png
diff --git a/...reenshots/patchscope-contributors-qtile-per_author-Tycho_Andersen-commits-W.png b/...reenshots/patchscope-contributors-qtile-per_author-Tycho_Andersen-commits-W.png
diff --git a/...tchscope-contributors-qtile-per_author-Tycho_Andersen-line_types_heatmap-QE.png b/...tchscope-contributors-qtile-per_author-Tycho_Andersen-line_types_heatmap-QE.png
diff --git a/docs/author_statistics.md b/docs/author_statistics.md
diff --git a/docs/contributors_graph.md b/docs/contributors_graph.md
@@ -215,6 +215,10 @@ For this diff/patch you get the same patch size of 3 lines: 1 modified, 2 remove
 [Closure-commit-db]: https://github.com/rjust/defects4j/blob/master/framework/projects/Closure/commit-db
 [Closure-40-repair]: https://program-repair.org/defects4j-dissection/#!/bug/Closure/40
 
+
+See also similar discussion in [Author Statistics](author_statistics.md)
+documentation.
+
 Here is how it looks in PatchScope (version **0.4.1**):
 
 ![](assets/screenshots/patchscope-contributors-qtile-all-patch_size.png)
@@ -273,6 +277,9 @@ This is not the only possible configuration.  For example, you might want
 comments in "test" files to count as "documentation", and only lines with
 some code count as "test".  This can be done with line callback.
 
+See also similar discussion in [Author Statistics](author_statistics.md)
+documentation.
+
 For the ± percentage (\[%]) line types distribution plots, like this heatmap
 plot, the percentage is computed as the number of added ('+') or deleted ('-')
 lines of given type (kind), over total number of added or deleted lines.

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -9,6 +9,7 @@ nav:
   #- installation: installation.md
   - usage:
      - contributors_graph.md
+     - author_statistics.md
   #- modules: api.md
   #- contributing: contributing.md
   #- authors: authors.md