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

A few Issues on page /docs/04-metadata.html #13

Open
jccaicedo opened this issue Sep 19, 2022 · 5 comments
Open

A few Issues on page /docs/04-metadata.html #13

jccaicedo opened this issue Sep 19, 2022 · 5 comments
Assignees

Comments

@jccaicedo
Copy link
Member

The first paragraph mentions Figure 3:

  • Can we add a link to the figure?
  • Are we sure the text refers to Figure 3 or Figure 2.
  • This chapter shows Figure 2 and another figure without caption. Can we add a caption and assign a number to the second figure?

In the paragraph before Figure 2, there is a link to Section 3. This link is incorrect and should now point to Section 5.

@rsenft1
Copy link
Member

rsenft1 commented Sep 27, 2022

We can solve both the first and second bullet using this notation to refer to figures: {numref}figure-name where figure-name is the name field in the figure (it actually is also wrapped in backticks). In this example, it would be index-file.

```{figure} images/image4.png
---
name: index-file
---
Screenshot of an example index.csv file

I've started doing this for figures on this page and we can also do it for other pages to make referencing consistent (and it will also update the name if we add a figure)

I also added a caption for the second figure and the link should be fixed. Tentatively, I believe everything here has been addressed

@Arkkienkeli
Copy link
Member

I have renamed index.csv or "index" across all the documentation (except command examples) to "metadata".
index.csv is a default name, but user can specify other name of metadata file.

@jccaicedo
Copy link
Member Author

Thank you @rsenft1 !
@Arkkienkeli is there anything missing in this issue? If not, feel free to close it.

@Arkkienkeli
Copy link
Member

@jccaicedo
I think we should describe single-cell metadata in this section.

@rsenft1
Copy link
Member

rsenft1 commented Nov 14, 2022

@Arkkienkeli , could you explain more what you mean by single-cell metadata? We do have a description of the single cell locations. Is there something else we should describe?

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

No branches or pull requests

4 participants