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

samtools reaheader not mentioned in the SYNOPSIS #29

Open
valeriuo opened this issue Jun 11, 2020 · 4 comments
Open

samtools reaheader not mentioned in the SYNOPSIS #29

valeriuo opened this issue Jun 11, 2020 · 4 comments

Comments

@valeriuo
Copy link
Contributor

There is a bottom link in the SEE ALSO section, but the command is not listed at the top of http://www.htslib.org/doc/samtools.html with all the others.

@jkbonfield
Copy link
Contributor

View is in there twice too. :)

These have already been fixed in samtools/samtools#1154 so I think it just needs the man pages regenerating online. I thought I'd done this (or added a PR for it), but apparently not.

@jkbonfield
Copy link
Contributor

jkbonfield commented Jun 11, 2020

I also think it would be nice if the online man page included links to the sub-command man pages in-situ as they're being listed in the COMMANDS section. They SEE ALSO has links, as does the synposis.

There is custom code to spot these in the synposis section:

elsif ($synopsis && /^(\S+)\s+(\S+)/ && -e "doc/$1-$2.1.html") {

Perhaps we should be looking for .TP followed by .B subcommand too so we can add them there as well.

@jmarshall
Copy link
Member

I don't think I got around to pushing it to manconvert yet but a while back I was making a companion script to facilitate spraying these hyperlinks around.

The other even better approach is to add some groff_man markup for it, that could be .deed to nothing at the top of the file but that manconvert could easily recognise. I recently learnt .UR/.UE are conventional for hyperlinks.

@valeriuo
Copy link
Contributor Author

These have already been fixed in samtools/samtools#1154 so I think it just needs the man pages regenerating online. I thought I'd done this (or added a PR for it), but apparently not.

Yes. It was more of a reminder to check for these issues, once we decide to make next release.

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

3 participants