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

[W13-2] Dive Log #40

Open
wants to merge 615 commits into
base: master
Choose a base branch
from

Conversation

arjo129
Copy link

@arjo129 arjo129 commented Oct 3, 2018

No description provided.

@okkhoy
Copy link

okkhoy commented Oct 21, 2018

@shuanang @arjo129 @cjunxiang @TTTaus

Your documentation updates are not picked up by reposense. Please make your repo reposense-compatible

Good landing page 👍

User guide

  • Remove reference to addressbook in the download link

Developer guide

  • in: Looking Up Dive Tables For Pressure Groups -> provide a link to PADI
  • Notation mistakes in the sequence diagram
  • Please update the rest of the UML diagrams to reflect your product; I don't think you can reuse most of them due the the changes in the class names and the design.

@arjo129
Copy link
Author

arjo129 commented Oct 21, 2018

Regarding reposense it seems like if we used //@@author tags, reposense does not automatically collate changes. It seems to give priority to those sections.

@okkhoy
Copy link

okkhoy commented Oct 21, 2018

I am not sure if @@author can be used in adoc. Awaiting confirmation from the reposense team!
From what I know, in code files, both commits and tags are honoured.
If your git config user.name was not set to your GitHub username, then using the _reposense\config.json is a better way to indicate all the usernames you used to make the commits.
Can you try that?

@okkhoy
Copy link

okkhoy commented Oct 21, 2018

Update:

markdown and adoc can use html comment syntax <!-- @@author abc -->
@arjo129

In addition, commit the _reposense\config.json before running reposense

@arjo129
Copy link
Author

arjo129 commented Oct 21, 2018

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants