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

Update developer guide to cover displays, and highlight working external plugins #1807

Merged
merged 2 commits into from
Mar 17, 2021
Merged

Update developer guide to cover displays, and highlight working external plugins #1807

merged 2 commits into from
Mar 17, 2021

Conversation

cmdcolin
Copy link
Collaborator

This does not address anything about making factory functions because we have seen that it is unnecessary

In order to try to most accurately direct people to the right place, it puts currently working external plugin links at the top

Then it also

  1. Removes completely the "ring the bell" track type example. Although fun, I could not get it to work, and it was non-functional as written
  2. Moves a specific internal codebase example to our CONTRIBUTING guide
  3. Fixes a color callback example in jexl, and adds it to volvox just so we can see results easily

@github-actions github-actions bot added the needs label triage Needs a label to show in changelog (breaking, enhancement, bug, documentation, or internal) label Mar 16, 2021
cmdcolin
cmdcolin commented Mar 16, 2021
View reviewed changes
website/docs/developer_guide.md
@@ -747,6 +827,9 @@ with your adapter.
alias for "1". An example of this in JBrowse is an adapter for
(alias files)[http://software.broadinstitute.org/software/igv/LoadData/#aliasfile]

Note about refname alias adapter: the first column must match what is seen in
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Xref #1775

@cmdcolin cmdcolin changed the title Update dev guide Update developer guide to cover displays, and highlight working external plugins Mar 17, 2021
@cmdcolin cmdcolin added documentation and removed needs label triage Needs a label to show in changelog (breaking, enhancement, bug, documentation, or internal) labels Mar 17, 2021
@cmdcolin cmdcolin requested a review from teresam856 March 17, 2021 03:20
@codecov
Copy link

codecov bot commented Mar 17, 2021 •
edited
Loading

Codecov Report

Merging #1807 (80668ce) into master (8c9d983) will increase coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1807   +/-   ##
=======================================
  Coverage   58.64%   58.65%           
=======================================
  Files         459      459           
  Lines       21291    21291           
  Branches     5021     5021           
=======================================
+ Hits        12486    12488    +2     
+ Misses       8495     8493    -2     
  Partials      310      310
Impacted Files Coverage Δ
packages/core/util/index.ts 81.52% <0.00%> (ø)
...inearGenomeView/components/RefNameAutocomplete.tsx 93.61% <0.00%> (+4.25%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8c9d983...80668ce. Read the comment docs.

teresam856
teresam856 reviewed Mar 17, 2021
View reviewed changes
website/docs/developer_guide.md
For example, we have a notion of a synteny track type, and the synteny track
type has two display models

- DotplotDisplay, which is used in the dotplot view
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we link to a source code example of displays being used?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think having the names of the displays may be a good starting point for a reader to find what is needed, but if you think it would help we can add an example too

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be good. We can start with the names. If we see down the road that users get confused then we can try adding an example.

teresam856
teresam856 approved these changes Mar 17, 2021
View reviewed changes
Copy link
Contributor

@teresam856 teresam856 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@cmdcolin cmdcolin merged commit b23352e into master Mar 17, 2021
@cmdcolin cmdcolin deleted the update_dev_guide branch March 17, 2021 23:39
@garrettjstevens garrettjstevens mentioned this pull request Mar 19, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@teresam856 teresam856 teresam856 approved these changes

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@cmdcolin @teresam856