From 5336187ee43328d954b136c4378a29afd9390624 Mon Sep 17 00:00:00 2001 From: BO ZHANG Date: Fri, 14 Oct 2022 11:14:15 +0800 Subject: [PATCH] tweaks --- doc/source/csst_common/csst_common.rst | 5 ++++- doc/source/vcs.rst | 6 +++--- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/doc/source/csst_common/csst_common.rst b/doc/source/csst_common/csst_common.rst index e80a8bc..2314114 100644 --- a/doc/source/csst_common/csst_common.rst +++ b/doc/source/csst_common/csst_common.rst @@ -1,7 +1,10 @@ Using ``csst_common`` ===================== -Some usages of the functions / classes in ``csst_common``. (To be updated) +In this chapter, we introduce the basic usages of some IMPORTANT functions / classes in ``csst_common``. +Package source code and installation guide can be found in the link below. + +- https://csst-tb.bao.ac.cn/code/csst-l1/csst_common ``csst_common.data_manager.CsstMsDataManager`` ---------------------------------------------- diff --git a/doc/source/vcs.rst b/doc/source/vcs.rst index 34bebbd..c5adda6 100644 --- a/doc/source/vcs.rst +++ b/doc/source/vcs.rst @@ -219,10 +219,10 @@ As a developer, you can also create a merge requrest to ask code reviewers to me First, click ``Merge requests`` tag, click `` .. image:: vcs/merge_request.png Second, select source branch and target branch, create a new merge request. + .. image:: vcs/pushed_to_dev.png +The code reviewers should then view the changes, and decide whether the changes should be approved. .. image:: vcs/create_merge_request.png -The code reviewers should then view the chagnes, and decide whether the changes should be approved. - .. image:: vcs/create_merge_request.png -If the changes are accepted, approve and merge the changes into `main` branch. +If the changes are accepted, approve and merge the changes into the `main` branch. .. image:: vcs/merge_approve.png After the changes have been merged, code reviewers should leave comment on the changes. .. image:: vcs/merged.png \ No newline at end of file -- GitLab