Skip to content

Commit 12c7ce5

Browse files
committed
feat: added required documentation for sessionspaces linting
1 parent 01d308b commit 12c7ce5

File tree

3 files changed

+5
-0
lines changed

3 files changed

+5
-0
lines changed

backend/sessionspaces/src/permissionables/instrument_subjects.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,8 @@ impl InstrumentGroup {
221221
}
222222

223223
impl InstrumentSubjects {
224+
/// Extract information from the LDAP cto get instrument-to-subject mappings
225+
/// Returns a mapping of instruments to user IDS who have access to those instruments
224226
#[instrument(name = "sessionspaces_fetch_instrument_subjects")]
225227
pub async fn fetch(ldap_connection: &mut Ldap) -> Result<Self, LdapError> {
226228
let mut instrument_subjects = Self::default();

backend/sessionspaces/src/permissionables/proposal_subjects.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ struct ProposalSubjectRow {
1414
}
1515

1616
impl ProposalSubjects {
17+
/// Create mappings for different proposals to their corresponding users that
18+
// have access to each proposal
1719
#[instrument(name = "fetch_proposal_subjects")]
1820
pub async fn fetch(ispyb_pool: &MySqlPool) -> Result<Self, sqlx::Error> {
1921
let mut proposal_subjects = Self::default();

backend/sessionspaces/src/resources/config_map.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ use tracing::{info, instrument};
1111
/// The name to be given to the ConfigMap
1212
const NAME: &str = "sessionspaces";
1313

14+
/// Create configmaps for every instrument session from visit information and visit directory
1415
#[instrument(name = "sessionspaces_create_configmap", skip(k8s_client, session))]
1516
pub async fn create_configmap(
1617
namespace: &str,

0 commit comments

Comments
 (0)